Download OpenAPI specification:Download
Fast Healthcare Interoperability Resources (FHIR, pronounced "Fire") defines a set of "Resources" that represent granular clinical concepts. The resources can be managed in isolation, or aggregated into complex documents. Technically, FHIR is designed for the web; the resources are based on simple XML or JSON structures, with an http-based RESTful protocol where each resource has predictable URL. Where possible, open internet standards are used for data representation.
| resourceType required | string non-empty |
| fhir_comments required | Array of objects |
| id required | string non-empty |
| text required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| balance | integer How much is in account? |
| identifier | string Account number |
| name | string Human-readable label |
| owner | string Who is responsible? |
| patient | string What is account tied to? |
| period | string <date> Transaction window |
| status | string active | inactive | entered-in-error |
| subject | string What is account tied to? |
| type | string E.g. patient, expense, depreciation |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| fhir_comments required | Array of objects |
| id required | string non-empty |
| text required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| composed-of | string What resource is being referenced |
| date | string <date> The activity definition publication date |
| depends-on | string What resource is being referenced |
| derived-from | string What resource is being referenced |
| description | string The description of the activity definition |
| effective | string <date> The time during which the activity definition is intended to be in use |
| identifier | string External identifier for the activity definition |
| jurisdiction | string Intended jurisdiction for the activity definition |
| name | string Computationally friendly name of the activity definition |
| predecessor | string What resource is being referenced |
| publisher | string Name of the publisher of the activity definition |
| status | string The current status of the activity definition |
| successor | string What resource is being referenced |
| title | string The human-friendly name of the activity definition |
| topic | string Topics associated with the module |
| url | string The uri that identifies the activity definition |
| version | string The business version of the activity definition |
| _format | string |
Success
| id required | string |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| category | string "AE | PAE An adverse event is an event that caused harm to a patient, an adverse reaction is a something that is a subject-specific event that is a result of an exposure to a medication, food, device or environmental substance, a potential adverse event is something that occurred and that could have caused harm to a patient but did not |
| date | string <date> When the event occurred |
| location | string Location where adverse event occurred |
| reaction | string Adverse Reaction Events linked to exposure to substance |
| recorder | string Who recorded the adverse event |
| seriousness | string Mild | Moderate | Severe |
| study | string AdverseEvent.study |
| subject | string Subject or group impacted by event |
| substance | string Refers to the specific entity that caused the adverse event |
| type | string actual | potential |
| _format | string |
Success
| id required | string |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| _status required | object |
| type required | string non-empty |
| _type required | object |
| category required | string non-empty |
| _category required | object |
| criticality required | string non-empty |
| _criticality required | object |
| substance required | object |
| patient required | object |
| recordedDate required | string non-empty |
| _recordedDate required | object |
| recorder required | object |
| reporter required | object |
| onset required | string non-empty |
| _onset required | object |
| lastOccurence required | string non-empty |
| _lastOccurence required | object |
| note required | Array of objects non-empty |
| reaction required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| asserter | string Source of the information about the allergy |
| category | string food | medication | environment | biologic |
| clinical-status | string active | inactive | resolved |
| code | string Code that identifies the allergy or intolerance |
| criticality | string low | high | unable-to-assess |
| date | string <date> Date record was believed accurate |
| identifier | string External ids for this item |
| last-date | string <date> Date(/time) of last known occurrence of a reaction |
| manifestation | string Clinical symptoms/signs associated with the Event |
| onset | string <date> Date(/time) when manifestations showed |
| patient | string Who the sensitivity is for |
| recorder | string Who recorded the sensitivity |
| route | string How the subject was exposed to the substance |
| severity | string mild | moderate | severe (of event as a whole) |
| type | string allergy | intolerance - Underlying mechanism (if known) |
| verification-status | string unconfirmed | confirmed | refuted | entered-in-error |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| _status required | object |
| type required | string non-empty |
| _type required | object |
| category required | string non-empty |
| _category required | object |
| criticality required | string non-empty |
| _criticality required | object |
| substance required | object |
| patient required | object |
| recordedDate required | string non-empty |
| _recordedDate required | object |
| recorder required | object |
| reporter required | object |
| onset required | string non-empty |
| _onset required | object |
| lastOccurence required | string non-empty |
| _lastOccurence required | object |
| note required | Array of objects non-empty |
| reaction required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| status required | string non-empty |
| serviceCategory required | object |
| serviceType required | Array of objects non-empty |
| specialty required | Array of objects non-empty |
| appointmentType required | object |
| priority required | number |
| description required | string non-empty |
| start required | string non-empty |
| end required | string non-empty |
| created required | string non-empty |
| comment required | string non-empty |
| participant required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| actor | string Any one of the individuals participating in the appointment |
| appointment-type | string The style of appointment or patient that has been booked in the slot (not service type) |
| date | string <date> Appointment date/time. |
| identifier | string An Identifier of the Appointment |
| incomingreferral | string The ReferralRequest provided as information to allocate to the Encounter |
| location | string This location is listed in the participants of the appointment |
| part-status | string The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests. |
| patient | string One of the individuals of the appointment is this patient |
| practitioner | string One of the individuals of the appointment is this practitioner |
| service-type | string The specific service that is to be performed during this appointment |
| status | string The overall status of the appointment |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| status required | string non-empty |
| serviceCategory required | object |
| serviceType required | Array of objects non-empty |
| specialty required | Array of objects non-empty |
| appointmentType required | object |
| priority required | number |
| description required | string non-empty |
| start required | string non-empty |
| end required | string non-empty |
| created required | string non-empty |
| comment required | string non-empty |
| participant required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| appointment required | object |
| actor required | object |
| participantStatus required | string non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| actor | string The Person, Location/HealthcareService or Device that this appointment response replies for |
| appointment | string The appointment that the response is attached to |
| identifier | string An Identifier in this appointment response |
| location | string This Response is for this Location |
| part-status | string The participants acceptance status for this appointment |
| patient | string This Response is for this Patient |
| practitioner | string This Response is for this Practitioner |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| appointment required | object |
| actor required | object |
| participantStatus required | string non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| type required | object |
| subtype required | Array of objects non-empty |
| action required | string non-empty |
| recorded required | string non-empty |
| outcome required | string non-empty |
| agent required | Array of objects non-empty |
| source required | object |
| entity required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| action | string Type of action performed during the event |
| address | string Identifier for the network access point of the user device |
| agent-name | string Human-meaningful name for the agent |
| agent | string Direct reference to resource |
| agent-role | string Agent role in the event |
| altid | string Alternative User id e.g. authentication |
| date | string <date> Time when the event occurred on source |
| entity-id | string Specific instance of object |
| entity-name | string Descriptor for entity |
| entity | string Specific instance of resource |
| entity-role | string What role the entity played |
| entity-type | string Type of entity involved |
| outcome | string Whether the event succeeded or failed |
| patient | string Direct reference to resource |
| policy | string Policy that authorized event |
| site | string Logical source location within the enterprise |
| source | string The identity of source detecting the event |
| subtype | string More specific type/id for the event |
| type | string Type/identifier of event |
| user | string Unique identifier for the user |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| type required | object |
| subtype required | Array of objects non-empty |
| action required | string non-empty |
| recorded required | string non-empty |
| outcome required | string non-empty |
| agent required | Array of objects non-empty |
| source required | object |
| entity required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| extension required | Array of objects non-empty |
| modifierExtension required | Array of objects non-empty |
| code required | object |
| subject required | object |
| created required | string non-empty |
| author required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| author | string Who created |
| code | string Kind of Resource |
| created | string <date> When created |
| identifier | string Business identifier |
| patient | string Identifies the focus of this resource |
| subject | string Identifies the focus of this resource |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| extension required | Array of objects non-empty |
| modifierExtension required | Array of objects non-empty |
| code required | object |
| subject required | object |
| created required | string non-empty |
| author required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| contentType required | string non-empty |
| content required | string non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| contenttype | string MimeType of the binary content |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| contentType required | string non-empty |
| content required | string non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| patient required | object |
| identifier required | Array of objects non-empty |
| code required | object |
| modifier required | Array of objects non-empty |
| description required | string non-empty |
| image required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| code | string Named anatomical location |
| identifier | string Identifier for this instance of the anatomical location |
| patient | string Patient to whom bodysite belongs |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| patient required | object |
| identifier required | Array of objects non-empty |
| code required | object |
| modifier required | Array of objects non-empty |
| description required | string non-empty |
| image required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| meta required | object |
| type required | string non-empty |
| total required | number |
| _total required | object |
| link required | Array of objects non-empty |
| entry required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| composition | string "The first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to searches its contents" |
| identifier | string Persistent identifier for the bundle |
| message | string "The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents" |
| type | string document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| meta required | object |
| type required | string non-empty |
| total required | number |
| _total required | object |
| link required | Array of objects non-empty |
| entry required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| date | string <date> The capability statement publication date |
| description | string The description of the capability statement |
| event | string Event code in a capability statement |
| fhirversion | string The version of FHIR |
| format | string formats supported (xml | json | ttl | mime type) |
| guide | string Implementation guides supported |
| jurisdiction | string Intended jurisdiction for the capability statement |
| mode | string Mode - restful (server/client) or messaging (sender/receiver) |
| name | string Computationally friendly name of the capability statement |
| publisher | string Name of the publisher of the capability statement |
| resource-profile | string A profile id invoked in a capability statement |
| resource | string Name of a resource mentioned in a capability statement |
| security-service | string OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates |
| software | string Part of a the name of a software application |
| status | string The current status of the capability statement |
| supported-profile | string Profiles for use cases supported |
| title | string The human-friendly name of the capability statement |
| url | string The uri that identifies the capability statement |
| version | string The business version of the capability statement |
| _format | string |
Success
| id required | string |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| contained required | Array of objects non-empty |
| subject required | object |
| status required | string non-empty |
| period required | object |
| addresses required | Array of objects non-empty |
| participant required | Array of objects non-empty |
| goal required | Array of objects non-empty |
| activity required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| activity-code | string Detail type of activity |
| activity-date | string <date> Specified date occurs within period specified by CarePlan.activity.timingSchedule |
| activity-reference | string Activity details defined in specific resource |
| based-on | string Fulfills care plan |
| care-team | string Who's involved in plan? |
| category | string Type of plan |
| condition | string Health issues this plan addresses |
| context | string Created in context of |
| date | string <date> Time period plan covers |
| definition | string Protocol or definition |
| encounter | string Created in context of |
| goal | string Desired outcome of plan |
| identifier | string External Ids for this plan |
| intent | string proposal | plan | order | option |
| part-of | string Part of referenced CarePlan |
| patient | string Who care plan is for |
| performer | string "Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)" |
| replaces | string CarePlan replaced by this CarePlan |
| status | string draft | active | suspended | completed | entered-in-error | cancelled | unknown |
| subject | string Who care plan is for |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| contained required | Array of objects non-empty |
| subject required | object |
| status required | string non-empty |
| period required | object |
| addresses required | Array of objects non-empty |
| participant required | Array of objects non-empty |
| goal required | Array of objects non-empty |
| activity required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| contained required | Array of objects non-empty |
| subject required | object |
| period required | object |
| participant required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| category | string Type of team |
| context | string Encounter or episode associated with CareTeam |
| date | string <date> Time period team covers |
| encounter | string Encounter or episode associated with CareTeam |
| identifier | string External Ids for this team |
| participant | string Who is involved |
| patient | string Who care team is for |
| status | string proposed | active | suspended | inactive | entered-in-error |
| subject | string Who care team is for |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| contained required | Array of objects non-empty |
| subject required | object |
| period required | object |
| participant required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| account | string Account to place this charge |
| code | string A code that identifies the charge, like a billing code |
| context | string Encounter / Episode associated with event |
| entered-date | string <date> Date the charge item was entered |
| enterer | string Individual who was entering |
| factor-override | number Factor overriding the associated rules |
| identifier | string Business Identifier for item |
| occurrence | string <date> When the charged service was applied |
| participant-actor | string Individual who was performing |
| participant-role | string What type of performance was done |
| patient | string Individual service was done for/to |
| performing-organization | string Organization providing the charged sevice |
| price-override | integer Price overriding the associated rules |
| quantity | integer Quantity of which the charge item has been serviced |
| requesting-organization | string Organization requesting the charged service |
| service | string Which rendered service is being charged? |
| subject | string Individual service was done for/to |
| _format | string |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| type required | string non-empty |
| identifier required | Array of objects non-empty |
| created required | string non-empty |
| targetReference required | object |
| organizationReference required | object |
| use required | string non-empty |
| priority required | object |
| payee required | object |
| diagnosis required | Array of objects non-empty |
| patientReference required | object |
| coverage required | Array of objects non-empty |
| item required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| care-team | string Member of the CareTeam |
| created | string <date> The creation date for the Claim |
| encounter | string Encounters associated with a billed line item |
| enterer | string The party responsible for the entry of the Claim |
| facility | string Facility responsible for the goods and services |
| identifier | string The primary identifier of the financial resource |
| insurer | string The target payor/insurer for the Claim |
| organization | string The reference to the providing organization |
| patient | string Patient receiving the services |
| payee | string The party receiving any payment for the Claim |
| priority | string Processing priority requested |
| provider | string Provider responsible for the Claim |
| use | string The kind of financial resource |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| type required | string non-empty |
| identifier required | Array of objects non-empty |
| created required | string non-empty |
| targetReference required | object |
| organizationReference required | object |
| use required | string non-empty |
| priority required | object |
| payee required | object |
| diagnosis required | Array of objects non-empty |
| patientReference required | object |
| coverage required | Array of objects non-empty |
| item required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| requestReference required | object |
| created required | string non-empty |
| organizationIdentifier required | object |
| outcome required | string non-empty |
| _outcome required | object |
| disposition required | string non-empty |
| payeeType required | object |
| item required | Array of objects non-empty |
| totalCost required | object |
| totalBenefit required | object |
| paymentDate required | string non-empty |
| _paymentDate required | object |
| paymentAmount required | object |
| paymentRef required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| created | string <date> The creation date |
| disposition | string The contents of the disposition message |
| identifier | string The identity of the claimresponse |
| insurer | string The organization who generated this resource |
| outcome | string The processing outcome |
| patient | string The subject of care. |
| payment-date | string <date> The expected paymentDate |
| request-provider | string The Provider of the claim |
| request | string The claim reference |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| requestReference required | object |
| created required | string non-empty |
| organizationIdentifier required | object |
| outcome required | string non-empty |
| _outcome required | object |
| disposition required | string non-empty |
| payeeType required | object |
| item required | Array of objects non-empty |
| totalCost required | object |
| totalBenefit required | object |
| paymentDate required | string non-empty |
| _paymentDate required | object |
| paymentAmount required | object |
| paymentRef required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| patient required | object |
| assessor required | object |
| status required | string non-empty |
| date required | string non-empty |
| description required | string non-empty |
| problem required | Array of objects non-empty |
| investigations required | Array of objects non-empty |
| summary required | string non-empty |
| finding required | Array of objects non-empty |
| plan required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| action | string Action taken as part of assessment procedure |
| assessor | string The clinician performing the assessment |
| context | string Encounter or Episode created from |
| date | string <date> When the assessment was documented |
| finding-code | string What was found |
| finding-ref | string What was found |
| identifier | string Business identifier |
| investigation | string Record of a specific investigation |
| patient | string Patient or group assessed |
| previous | string Reference to last assessment |
| problem | string Relevant impressions of patient state |
| status | string draft | completed | entered-in-error |
| subject | string Patient or group assessed |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| patient required | object |
| assessor required | object |
| status required | string non-empty |
| date required | string non-empty |
| description required | string non-empty |
| problem required | Array of objects non-empty |
| investigations required | Array of objects non-empty |
| summary required | string non-empty |
| finding required | Array of objects non-empty |
| plan required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| meta required | object |
| text required | object |
| url required | string non-empty |
| _url required | object |
| identifier required | object |
| version required | string non-empty |
| _version required | object |
| name required | string non-empty |
| status required | string non-empty |
| experimental required | boolean |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| date required | string non-empty |
| description required | string non-empty |
| caseSensitive required | boolean |
| _caseSensitive required | object |
| content required | string non-empty |
| concept required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| code | string A code defined in the code system |
| content-mode | string not-present | example | fragment | complete |
| date | string <date> The code system publication date |
| description | string The description of the code system |
| identifier | string External identifier for the code system |
| jurisdiction | string Intended jurisdiction for the code system |
| language | string A language in which a designation is provided |
| name | string Computationally friendly name of the code system |
| publisher | string Name of the publisher of the code system |
| status | string The current status of the code system |
| system | string The system for any codes defined by this code system (same as 'url') |
| title | string The human-friendly name of the code system |
| url | string The uri that identifies the code system |
| version | string The business version of the code system |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| meta required | object |
| text required | object |
| url required | string non-empty |
| _url required | object |
| identifier required | object |
| version required | string non-empty |
| _version required | object |
| name required | string non-empty |
| status required | string non-empty |
| experimental required | boolean |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| date required | string non-empty |
| description required | string non-empty |
| caseSensitive required | boolean |
| _caseSensitive required | object |
| content required | string non-empty |
| concept required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| category required | object |
| sender required | object |
| recipient required | Array of objects non-empty |
| payload required | Array of objects non-empty |
| status required | string non-empty |
| sent required | string non-empty |
| subject required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| based-on | string Request fulfilled by this communication |
| category | string Message category |
| context | string Encounter or episode leading to message |
| definition | string Instantiates protocol or definition |
| encounter | string Encounter leading to message |
| identifier | string Unique identifier |
| medium | string A channel of communication |
| part-of | string Part of this action |
| patient | string Focus of message |
| received | string <date> When received |
| recipient | string Message recipient |
| sender | string Message sender |
| sent | string <date> When sent |
| status | string preparation | in-progress | suspended | aborted | completed | entered-in-error |
| subject | string Focus of message |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| category required | object |
| sender required | object |
| recipient required | Array of objects non-empty |
| payload required | Array of objects non-empty |
| status required | string non-empty |
| sent required | string non-empty |
| subject required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| subject required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| authored | string <date> When request transitioned to being actionable |
| based-on | string Fulfills plan or proposal |
| category | string Message category |
| context | string Encounter or episode leading to message |
| encounter | string Encounter leading to message |
| group-identifier | string Composite request this is part of |
| identifier | string Unique identifier |
| medium | string A channel of communication |
| occurrence | string <date> When scheduled |
| patient | string Focus of message |
| priority | string Message urgency |
| recipient | string Message recipient |
| replaces | string Request(s) replaced by this request |
| requester | string Individual making the request |
| sender | string Message sender |
| status | string draft | active | suspended | cancelled | completed | entered-in-error | unknown |
| subject | string Focus of message |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| subject required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| code | string Patient | Encounter | RelatedPerson | Practitioner | Device |
| date | string <date> The compartment definition publication date |
| description | string The description of the compartment definition |
| jurisdiction | string Intended jurisdiction for the compartment definition |
| name | string Computationally friendly name of the compartment definition |
| publisher | string Name of the publisher of the compartment definition |
| resource | string Name of resource type |
| status | string The current status of the compartment definition |
| title | string The human-friendly name of the compartment definition |
| url | string The uri that identifies the compartment definition |
| _format | string |
Success
| id required | string |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | object |
| date required | string non-empty |
| type required | object |
| class required | object |
| title required | string non-empty |
| status required | string non-empty |
| confidentiality required | string non-empty |
| subject required | object |
| author required | Array of objects non-empty |
| attester required | Array of objects non-empty |
| custodian required | object |
| event required | Array of objects non-empty |
| encounter required | object |
| section required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| attester | string Who attested the composition |
| author | string Who and/or what authored the composition |
| class | string Categorization of Composition |
| confidentiality | string As defined by affinity domain |
| context | string Code(s) that apply to the event being documented |
| date | string <date> Composition editing time |
| encounter | string Context of the Composition |
| entry | string A reference to data that supports this section |
| identifier | string Logical identifier of composition (version-independent) |
| patient | string Who and/or what the composition is about |
| period | string <date> The period covered by the documentation |
| related-id | string Target of the relationship |
| related-ref | string Target of the relationship |
| section | string Classification of section (recommended) |
| status | string preliminary | final | amended | entered-in-error |
| subject | string Who and/or what the composition is about |
| title | string Human Readable name/title |
| type | string Kind of composition (LOINC if possible) |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | object |
| date required | string non-empty |
| type required | object |
| class required | object |
| title required | string non-empty |
| status required | string non-empty |
| confidentiality required | string non-empty |
| subject required | object |
| author required | Array of objects non-empty |
| attester required | Array of objects non-empty |
| custodian required | object |
| event required | Array of objects non-empty |
| encounter required | object |
| section required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| url required | string non-empty |
| identifier required | object |
| version required | string non-empty |
| _version required | object |
| name required | string non-empty |
| _name required | object |
| status required | string non-empty |
| experimental required | boolean |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| date required | string non-empty |
| description required | string non-empty |
| useContext required | Array of objects non-empty |
| requirements required | string non-empty |
| copyright required | string non-empty |
| sourceReference required | object |
| targetReference required | object |
| element required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| date | string <date> The concept map publication date |
| dependson | string Reference to property mapping depends on |
| description | string The description of the concept map |
| identifier | string External identifier for the concept map |
| jurisdiction | string Intended jurisdiction for the concept map |
| name | string Computationally friendly name of the concept map |
| other | string Canonical URL for other concept map |
| product | string Reference to property mapping depends on |
| publisher | string Name of the publisher of the concept map |
| source-code | string Identifies element being mapped |
| source | string Identifies the source of the concepts which are being mapped |
| source-system | string Code System (if value set crosses code systems) |
| source-uri | string Identifies the source of the concepts which are being mapped |
| status | string The current status of the concept map |
| target-code | string Code that identifies the target element |
| target | string Provides context to the mappings |
| target-system | string System of the target (if necessary) |
| target-uri | string Provides context to the mappings |
| title | string The human-friendly name of the concept map |
| url | string The uri that identifies the concept map |
| version | string The business version of the concept map |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| url required | string non-empty |
| identifier required | object |
| version required | string non-empty |
| _version required | object |
| name required | string non-empty |
| _name required | object |
| status required | string non-empty |
| experimental required | boolean |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| date required | string non-empty |
| description required | string non-empty |
| useContext required | Array of objects non-empty |
| requirements required | string non-empty |
| copyright required | string non-empty |
| sourceReference required | object |
| targetReference required | object |
| element required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| patient required | object |
| code required | object |
| category required | object |
| verificationStatus required | string non-empty |
| severity required | object |
| onsetDateTime required | string non-empty |
| bodySite required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| abatement-age | integer Abatement as age or age range |
| abatement-boolean | string Abatement boolean (boolean is true or non-boolean values are present) |
| abatement-date | string <date> Date-related abatements (dateTime and period) |
| abatement-string | string Abatement as a string |
| asserted-date | string <date> Date record was believed accurate |
| asserter | string Person who asserts this condition |
| body-site | string Anatomical location, if relevant |
| category | string The category of the condition |
| clinical-status | string The clinical status of the condition |
| code | string Code for the condition |
| context | string Encounter or episode when condition first asserted |
| encounter | string Encounter when condition first asserted |
| evidence-detail | string Supporting information found elsewhere |
| evidence | string Manifestation/symptom |
| identifier | string A unique identifier of the condition record |
| onset-age | integer Onsets as age or age range |
| onset-date | string <date> Date related onsets (dateTime and Period) |
| onset-info | string Onsets as a string |
| patient | string Who has the condition? |
| severity | string The severity of the condition |
| stage | string Simple summary (disease specific) |
| subject | string Who has the condition? |
| verification-status | string provisional | differential | confirmed | refuted | entered-in-error | unknown |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| patient required | object |
| code required | object |
| category required | object |
| verificationStatus required | string non-empty |
| severity required | object |
| onsetDateTime required | string non-empty |
| bodySite required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | number |
| meta required | object |
| identifier required | object |
| status required | string non-empty |
| category required | Array of objects non-empty |
| patient required | object |
| period required | object |
| dateTime required | string non-empty |
| purpose required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| action | string Actions controlled by this consent |
| actor | string Resource for the actor (or group, by role) |
| category | string Classification of the consent statement - for indexing/retrieval |
| consentor | string Who is agreeing to the policy and exceptions |
| data | string The actual data reference |
| date | string <date> When this Consent was created or indexed |
| identifier | string Identifier for this record (external references) |
| organization | string Custodian of the consent |
| patient | string Who the consent applies to |
| period | string <date> Period that this consent applies |
| purpose | string Context of activities for which the agreement is made |
| securitylabel | string Security Labels that define affected resources |
| source | string Source from which this consent is taken |
| status | string draft | proposed | active | rejected | inactive | entered-in-error |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | number |
| meta required | object |
| identifier required | object |
| status required | string non-empty |
| category required | Array of objects non-empty |
| patient required | object |
| period required | object |
| dateTime required | string non-empty |
| purpose required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| fhir_comments required | Array of objects |
| id required | string non-empty |
| text required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| agent | string Agent to the Contact |
| authority | string The authority of the contract |
| domain | string The domain of the contract |
| identifier | string The identity of the contract |
| issued | string <date> The date/time the contract was issued |
| patient | string The identity of the subject of the contract (if a patient) |
| signer | string Contract Signatory Party |
| subject | string The identity of the subject of the contract |
| term-topic | string The identity of the topic of the contract terms |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| fhir_comments required | Array of objects |
| id required | string non-empty |
| text required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| issuerReference required | object |
| period required | object |
| type required | object |
| planholderReference required | object |
| beneficiaryReference required | object |
| relationship required | object |
| identifier required | Array of objects non-empty |
| plan required | string non-empty |
| subPlan required | string non-empty |
| dependent required | number |
| sequence required | number |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| beneficiary | string Covered party |
| class | string Class identifier |
| dependent | string Dependent number |
| group | string Group identifier |
| identifier | string The primary identifier of the insured and the coverage |
| payor | string The identity of the insurer or party paying for services |
| plan | string A plan or policy identifier |
| policy-holder | string Reference to the policyholder |
| sequence | string Sequence number |
| subclass | string Sub-class identifier |
| subgroup | string Sub-group identifier |
| subplan | string Sub-plan identifier |
| subscriber | string Reference to the subscriber |
| type | string The kind of coverage (health plan, auto, Workers Compensation) |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| issuerReference required | object |
| period required | object |
| type required | object |
| planholderReference required | object |
| beneficiaryReference required | object |
| relationship required | object |
| identifier required | Array of objects non-empty |
| plan required | string non-empty |
| subPlan required | string non-empty |
| dependent required | number |
| sequence required | number |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| contained required | Array of objects non-empty |
| identifier required | Array of objects non-empty |
| version required | string non-empty |
| status required | string non-empty |
| publisher required | string non-empty |
| name required | string non-empty |
| useContext required | Array of objects non-empty |
| element required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| code | string A code for the data element (server may choose to do subsumption) |
| date | string <date> The data element publication date |
| description | string Text search in the description of the data element. This corresponds to the definition of the first DataElement.element. |
| identifier | string External identifier for the data element |
| jurisdiction | string Intended jurisdiction for the data element |
| name | string Computationally friendly name of the data element |
| publisher | string Name of the publisher of the data element |
| status | string The current status of the data element |
| stringency | string The stringency of the data element definition |
| title | string The human-friendly name of the data element |
| url | string The uri that identifies the data element |
| version | string The business version of the data element |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| contained required | Array of objects non-empty |
| identifier required | Array of objects non-empty |
| version required | string non-empty |
| status required | string non-empty |
| publisher required | string non-empty |
| name required | string non-empty |
| useContext required | Array of objects non-empty |
| element required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| category required | object |
| severity required | string non-empty |
| implicated required | Array of objects non-empty |
| detail required | string non-empty |
| date required | string non-empty |
| author required | object |
| mitigation required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| author | string The provider or device that identified the issue |
| category | string Issue Category, e.g. drug-drug, duplicate therapy, etc. |
| date | string <date> When identified |
| identifier | string Unique id for the detected issue |
| implicated | string Problem resource |
| patient | string Associated patient |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| category required | object |
| severity required | string non-empty |
| implicated required | Array of objects non-empty |
| detail required | string non-empty |
| date required | string non-empty |
| author required | object |
| mitigation required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| _id required | object |
| text required | object |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| type required | object |
| lotNumber required | string non-empty |
| manufacturer required | string non-empty |
| model required | string non-empty |
| contact required | Array of objects non-empty |
| note required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| device-name | string A server defined search that may match any of the string fields in the Device.udi.name or Device.type.coding.display or Device.type.text |
| identifier | string Instance id from manufacturer, owner, and others |
| location | string A location, where the resource is found |
| manufacturer | string The manufacturer of the device |
| model | string The model of the device |
| organization | string The organization responsible for the device |
| patient | string Patient information, if the resource is affixed to a person |
| status | string active | inactive | entered-in-error | unknown |
| type | string The type of the device |
| udi-carrier | string UDI Barcode (RFID or other technology) string either in HRF format or AIDC format converted to base64 string. |
| udi-di | string The udi Device Identifier (DI) |
| url | string Network address to contact device |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| _id required | object |
| text required | object |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| type required | object |
| lotNumber required | string non-empty |
| manufacturer required | string non-empty |
| model required | string non-empty |
| contact required | Array of objects non-empty |
| note required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| _id required | object |
| text required | object |
| contained required | Array of objects non-empty |
| type required | object |
| identifier required | object |
| lastSystemChange required | string non-empty |
| source required | object |
| operationalStatus required | Array of objects non-empty |
| languageCode required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| identifier | string The identifier of the component |
| parent | string The parent DeviceComponent resource |
| source | string The device source |
| type | string The device component type |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| _id required | object |
| text required | object |
| contained required | Array of objects non-empty |
| type required | object |
| identifier required | object |
| lastSystemChange required | string non-empty |
| source required | object |
| operationalStatus required | Array of objects non-empty |
| languageCode required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| type required | object |
| identifier required | object |
| unit required | object |
| category required | string non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| category | string The category of the metric |
| identifier | string The identifier of the metric |
| parent | string The parent DeviceMetric resource |
| source | string The device resource |
| type | string The component type |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| type required | object |
| identifier required | object |
| unit required | object |
| category required | string non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| authored-on | string <date> When the request transitioned to being actionable |
| based-on | string Plan/proposal/order fulfilled by this request |
| code | string Code for what is being requested/ordered |
| definition | string Protocol or definition followed by this request |
| device | string Reference to resource that is being requested/ordered |
| encounter | string Encounter or Episode during which request was created |
| event-date | string <date> When service should occur |
| group-identifier | string Composite request this is part of |
| identifier | string Business identifier for request/order |
| intent | string proposal | plan | original-order |reflex-order |
| patient | string Individual the service is ordered for |
| performer | string Desired performer for service |
| priorrequest | string Request takes the place of referenced completed or terminated requests |
| requester | string Who/what is requesting service |
| status | string entered-in-error | draft | active |suspended | completed |
| subject | string Individual the service is ordered for |
| _format | string |
Success
| id required | string |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| device required | object |
| subject required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| device | string Search by device |
| identifier | string Search by identifier |
| patient | string Search by subject - a patient |
| subject | string Search by subject |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| device required | object |
| subject required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| contained required | Array of objects non-empty |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| category required | object |
| code required | object |
| subject required | object |
| encounter required | object |
| effectiveDateTime required | string non-empty |
| issued required | string non-empty |
| _issued required | object |
| performer required | object |
| result required | Array of objects non-empty |
| presentedForm required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| based-on | string Reference to the procedure request. |
| category | string Which diagnostic discipline/department created the report |
| code | string The code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result |
| context | string Healthcare event (Episode of Care or Encounter) related to the report |
| date | string <date> The clinically relevant time of the report |
| diagnosis | string A coded diagnosis on the report |
| encounter | string The Encounter when the order was made |
| identifier | string An identifier for the report |
| image | string A reference to the image source. |
| issued | string <date> When the report was issued |
| patient | string The subject of the report if a patient |
| performer | string Who was the source of the report (organization) |
| result | string Link to an atomic result (observation resource) |
| specimen | string The specimen details |
| status | string The status of the report |
| subject | string The subject of the report |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| contained required | Array of objects non-empty |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| category required | object |
| code required | object |
| subject required | object |
| encounter required | object |
| effectiveDateTime required | string non-empty |
| issued required | string non-empty |
| _issued required | object |
| performer required | object |
| result required | Array of objects non-empty |
| presentedForm required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| author | string Who and/or what authored the manifest |
| content-ref | string Contents of this set of documents |
| created | string <date> When this document manifest created |
| description | string Human-readable description (title) |
| identifier | string Unique Identifier for the set of documents |
| patient | string The subject of the set of documents |
| recipient | string Intended to get notified about this set of documents |
| related-id | string Identifiers of things that are related |
| related-ref | string Related Resource |
| source | string The source system/application/software |
| status | string current | superseded | entered-in-error |
| subject | string The subject of the set of documents |
| type | string Kind of document set |
| _format | string |
Success
| id required | string |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| contained required | Array of objects non-empty |
| masterIdentifier required | object |
| identifier required | Array of objects non-empty |
| subject required | object |
| type required | object |
| class required | object |
| author required | Array of objects non-empty |
| custodian required | object |
| authenticator required | object |
| created required | string non-empty |
| indexed required | string non-empty |
| status required | string non-empty |
| docStatus required | object |
| relatesTo required | Array of objects non-empty |
| description required | string non-empty |
| securityLabel required | Array of objects non-empty |
| content required | Array of objects non-empty |
| context required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| authenticator | string Who/what authenticated the document |
| author | string Who and/or what authored the document |
| class | string Categorization of document |
| created | string <date> Document creation time |
| custodian | string Organization which maintains the document |
| description | string Human-readable description (title) |
| encounter | string Context of the document content |
| event | string Main clinical acts documented |
| facility | string Kind of facility where patient was seen |
| format | string Format/content rules for the document |
| identifier | string Master Version Specific Identifier |
| indexed | string <date> When this document reference was created |
| language | string Human language of the content (BCP-47) |
| location | string Uri where the data can be found |
| patient | string Who/what is the subject of the document |
| period | string <date> Time of service that is being documented |
| related-id | string Identifier of related objects or events |
| related-ref | string Related Resource |
| relatesto | string Target of the relationship |
| relationship | string Combination of relation and relatesTo |
| relation | string replaces | transforms | signs | appends |
| securitylabel | string Document security-tags |
| setting | string Additional details about where the content was created (e.g. clinical specialty) |
| status | string current | superseded | entered-in-error |
| subject | string Who/what is the subject of the document |
| type | string Kind of document (LOINC if possible) |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| contained required | Array of objects non-empty |
| masterIdentifier required | object |
| identifier required | Array of objects non-empty |
| subject required | object |
| type required | object |
| class required | object |
| author required | Array of objects non-empty |
| custodian required | object |
| authenticator required | object |
| created required | string non-empty |
| indexed required | string non-empty |
| status required | string non-empty |
| docStatus required | object |
| relatesTo required | Array of objects non-empty |
| description required | string non-empty |
| securityLabel required | Array of objects non-empty |
| content required | Array of objects non-empty |
| context required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| created required | string non-empty |
| targetReference required | object |
| organizationReference required | object |
| priority required | object |
| patientReference required | object |
| coverageReference required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| created | string <date> The creation date for the EOB |
| enterer | string The party who is responsible for the request |
| facility | string Facility responsible for the goods and services |
| identifier | string The business identifier of the Eligibility |
| organization | string The reference to the providing organization |
| patient | string The reference to the patient |
| provider | string The reference to the provider |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| created required | string non-empty |
| targetReference required | object |
| organizationReference required | object |
| priority required | object |
| patientReference required | object |
| coverageReference required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| requestReference required | object |
| outcome required | string non-empty |
| disposition required | string non-empty |
| created required | string non-empty |
| organizationReference required | object |
| inforce required | boolean |
| _inforce required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| created | string <date> The creation date |
| disposition | string The contents of the disposition message |
| identifier | string The business identifier |
| insurer | string The organization which generated this resource |
| outcome | string The processing outcome |
| request-organization | string The EligibilityRequest organization |
| request-provider | string The EligibilityRequest provider |
| request | string The EligibilityRequest reference |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| requestReference required | object |
| outcome required | string non-empty |
| disposition required | string non-empty |
| created required | string non-empty |
| organizationReference required | object |
| inforce required | boolean |
| _inforce required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| status required | string non-empty |
| class required | string non-empty |
| patient required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| appointment | string The appointment that scheduled this encounter |
| class | string inpatient | outpatient | ambulatory | emergency + |
| date | string <date> A date within the period the Encounter lasted |
| diagnosis | string Reason the encounter takes place (resource) |
| episodeofcare | string Episode(s) of care that this encounter should be recorded against |
| identifier | string Identifier(s) by which this encounter is known |
| incomingreferral | string The ReferralRequest that initiated this encounter |
| length | number Length of encounter in days |
| location-period | string <date> Time period during which the patient was present at the location |
| location | string Location the encounter takes place |
| participant | string Persons involved in the encounter other than the patient |
| participant-type | string Role of participant in encounter |
| part-of | string Another Encounter this encounter is part of |
| patient | string The patient ro group present at the encounter |
| practitioner | string Persons involved in the encounter other than the patient |
| reason | string Reason the encounter takes place (code) |
| service-provider | string The custodian organization of this Encounter record |
| special-arrangement | string Wheelchair, translator, stretcher, etc. |
| status | string planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
| subject | string The patient ro group present at the encounter |
| type | string Specific type of encounter |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| status required | string non-empty |
| class required | string non-empty |
| patient required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| connection-type | string Protocol/Profile/Standard to be used with this endpoint connection |
| identifier | string Identifies this endpoint across multiple systems |
| name | string A name that this endpoint can be identified by |
| organization | string The organization that is managing the endpoint |
| payload-type | string The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) |
| status | string The current status of the Endpoint (usually expected to be active) |
| _format | string |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| created required | string non-empty |
| organization required | object |
| subject required | object |
| coverage required | object |
| relationship required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| identifier | string The business identifier of the Enrollment |
| organization | string The organization who generated this resource |
| patient | string The party to be enrolled |
| subject | string The party to be enrolled |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| created required | string non-empty |
| organization required | object |
| subject required | object |
| coverage required | object |
| relationship required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| request required | object |
| outcome required | string non-empty |
| disposition required | string non-empty |
| created required | string non-empty |
| organization required | object |
| requestOrganization required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| identifier | string The business identifier of the EnrollmentResponse |
| organization | string The organization who generated this resource |
| request | string The reference to the claim |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| request required | object |
| outcome required | string non-empty |
| disposition required | string non-empty |
| created required | string non-empty |
| organization required | object |
| requestOrganization required | object |
Success
| resourceType required | string non-empty |
| fhir_comments required | Array of objects |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| statusHistory required | Array of objects non-empty |
| type required | Array of objects non-empty |
| condition required | Array of objects non-empty |
| patient required | object |
| managingOrganization required | object |
| period required | object |
| referralRequest required | Array of objects non-empty |
| careManager required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| care-manager | string Care manager/care co-ordinator for the patient |
| condition | string Conditions/problems/diagnoses this episode of care is for |
| date | string <date> The provided date search value falls within the episode of care's period |
| identifier | string Business Identifier(s) relevant for this EpisodeOfCare |
| incomingreferral | string Incoming Referral Request |
| organization | string The organization that has assumed the specific responsibilities of this EpisodeOfCare |
| patient | string The patient who is the focus of this episode of care |
| status | string The current status of the Episode of Care as provided (does not check the status history collection) |
| type | string Type/class - e.g. specialist referral, disease management |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| fhir_comments required | Array of objects |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| statusHistory required | Array of objects non-empty |
| type required | Array of objects non-empty |
| condition required | Array of objects non-empty |
| patient required | object |
| managingOrganization required | object |
| period required | object |
| referralRequest required | Array of objects non-empty |
| careManager required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| status required | string non-empty |
| experimental required | boolean |
| excludeNested required | boolean |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| date | string <date> The expansion profile publication date |
| description | string The description of the expansion profile |
| identifier | string External identifier for the expansion profile |
| jurisdiction | string Intended jurisdiction for the expansion profile |
| name | string Computationally friendly name of the expansion profile |
| publisher | string Name of the publisher of the expansion profile |
| status | string The current status of the expansion profile |
| url | string The uri that identifies the expansion profile |
| version | string The business version of the expansion profile |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| status required | string non-empty |
| experimental required | boolean |
| excludeNested required | boolean |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| claimReference required | object |
| created required | string non-empty |
| _created required | object |
| disposition required | string non-empty |
| organizationReference required | object |
| patientReference required | object |
| coverage required | object |
| item required | Array of objects non-empty |
| totalCost required | object |
| totalBenefit required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| care-team | string Member of the CareTeam |
| claim | string The reference to the claim |
| coverage | string The plan under which the claim was adjudicated |
| created | string <date> The creation date for the EOB |
| disposition | string The contents of the disposition message |
| encounter | string Encounters associated with a billed line item |
| enterer | string The party responsible for the entry of the Claim |
| facility | string Facility responsible for the goods and services |
| identifier | string The business identifier of the Explanation of Benefit |
| organization | string The reference to the providing organization |
| patient | string The reference to the patient |
| payee | string The party receiving any payment for the Claim |
| provider | string The reference to the provider |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| claimReference required | object |
| created required | string non-empty |
| _created required | object |
| disposition required | string non-empty |
| organizationReference required | object |
| patientReference required | object |
| coverage required | object |
| item required | Array of objects non-empty |
| totalCost required | object |
| totalBenefit required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| patient required | object |
| date required | string non-empty |
| status required | string non-empty |
| relationship required | object |
| condition required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| code | string A search by a condition code |
| date | string <date> When history was captured/updated |
| definition | string Instantiates protocol or definition |
| gender | string A search by a gender code of a family member |
| identifier | string A search by a record identifier |
| patient | string The identity of a subject to list family member history items for |
| relationship | string A search by a relationship type |
| status | string partial | completed | entered-in-error | health-unknown |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| patient required | object |
| date required | string non-empty |
| status required | string non-empty |
| relationship required | object |
| condition required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| category required | object |
| status required | string non-empty |
| subject required | object |
| author required | object |
| code required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| author | string Flag creator |
| date | string <date> Time period when flag is active |
| encounter | string Alert relevant during encounter |
| identifier | string Business identifier |
| patient | string The identity of a subject to list flags for |
| subject | string The identity of a subject to list flags for |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| category required | object |
| status required | string non-empty |
| subject required | object |
| author required | object |
| code required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| extension required | Array of objects non-empty |
| subject required | object |
| description required | string non-empty |
| status required | string non-empty |
| addresses required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| category | string E.g. Treatment, dietary, behavioral, etc. |
| identifier | string External Ids for this goal |
| patient | string Who this goal is intended for |
| start-date | string <date> When goal pursuit begins |
| status | string proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected |
| subject | string Who this goal is intended for |
| target-date | string <date> Reach goal on or before |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| extension required | Array of objects non-empty |
| subject required | object |
| description required | string non-empty |
| status required | string non-empty |
| addresses required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| date | string <date> The graph definition publication date |
| description | string The description of the graph definition |
| jurisdiction | string Intended jurisdiction for the graph definition |
| name | string Computationally friendly name of the graph definition |
| publisher | string Name of the publisher of the graph definition |
| start | string Type of resource at which the graph starts |
| status | string The current status of the graph definition |
| url | string The uri that identifies the graph definition |
| version | string The business version of the graph definition |
| _format | string |
Success
| id required | string |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| type required | string non-empty |
| actual required | boolean |
| code required | object |
| name required | string non-empty |
| quantity required | number |
| characteristic required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| actual | string Descriptive or actual |
| characteristic | string Kind of characteristic |
| characteristic-value | string A composite of both characteristic and value |
| code | string The kind of resources contained |
| exclude | string Group includes or excludes |
| identifier | string Unique id |
| member | string Reference to the group member |
| type | string The type of resources the group contains |
| value | string Value held by characteristic |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| type required | string non-empty |
| actual required | boolean |
| code required | object |
| name required | string non-empty |
| quantity required | number |
| characteristic required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| module required | object |
| status required | string non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| identifier | string The identifier of the guidance response |
| patient | string The identity of a patient to search for guidance response results |
| request | string The identifier of the request associated with the response |
| subject | string The subject that the guidance response is about |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| module required | object |
| status required | string non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| contained required | Array of objects non-empty |
| serviceType required | Array of objects non-empty |
| specialty required | Array of objects non-empty |
| location required | Array of objects non-empty |
| serviceName required | string non-empty |
| comment required | string non-empty |
| extraDetails required | string non-empty |
| telecom required | Array of objects non-empty |
| coverageArea required | Array of objects non-empty |
| eligibility required | object |
| eligibilityNote required | string non-empty |
| programName required | Array of objects |
| characteristic required | Array of objects non-empty |
| referralMethod required | Array of objects non-empty |
| publicKey required | string non-empty |
| appointmentRequired required | boolean |
| availableTime required | Array of objects non-empty |
| notAvailable required | Array of objects non-empty |
| availabilityExceptions required | string non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| active | string The Healthcare Service is currently marked as active |
| category | string Service Category of the Healthcare Service |
| characteristic | string One of the HealthcareService's characteristics |
| endpoint | string Technical endpoints providing access to services operated for the location |
| identifier | string External identifiers for this item |
| location | string The location of the Healthcare Service |
| name | string A portion of the Healthcare service name |
| organization | string The organization that provides this Healthcare Service |
| programname | string One of the Program Names serviced by this HealthcareService |
| type | string The type of service provided by this healthcare service |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| contained required | Array of objects non-empty |
| serviceType required | Array of objects non-empty |
| specialty required | Array of objects non-empty |
| location required | Array of objects non-empty |
| serviceName required | string non-empty |
| comment required | string non-empty |
| extraDetails required | string non-empty |
| telecom required | Array of objects non-empty |
| coverageArea required | Array of objects non-empty |
| eligibility required | object |
| eligibilityNote required | string non-empty |
| programName required | Array of objects |
| characteristic required | Array of objects non-empty |
| referralMethod required | Array of objects non-empty |
| publicKey required | string non-empty |
| appointmentRequired required | boolean |
| availableTime required | Array of objects non-empty |
| notAvailable required | Array of objects non-empty |
| availabilityExceptions required | string non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| authoring-time | string <date> Time of the ImagingManifest (or a DICOM Key Object Selection which it represents) authoring |
| author | string Author of the ImagingManifest (or a DICOM Key Object Selection which it represents) |
| endpoint | string The endpoint for the study or series |
| identifier | string UID of the ImagingManifest (or a DICOM Key Object Selection which it represents) |
| imaging-study | string ImagingStudy resource selected in the ImagingManifest (or a DICOM Key Object Selection which it represents) |
| patient | string Subject of the ImagingManifest (or a DICOM Key Object Selection which it represents) |
| selected-study | string Study selected in the ImagingManifest (or a DICOM Key Object Selection which it represents) |
| _format | string |
Success
| id required | string |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| uid required | string non-empty |
| patient required | object |
| started required | string non-empty |
| numberOfSeries required | number |
| numberOfInstances required | number |
| series required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| accession | string The accession identifier for the study |
| basedon | string The order for the image |
| bodysite | string The body site studied |
| context | string The context of the study |
| dicom-class | string The type of the instance |
| endpoint | string The endpoint for te study or series |
| identifier | string Other identifiers for the Study |
| modality | string The modality of the series |
| patient | string Who the study is about |
| performer | string The person who performed the study |
| reason | string The reason for the study |
| series | string The identifier of the series of images |
| started | string <date> When the study was started |
| study | string The study identifier for the image |
| uid | string The instance unique identifier |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| uid required | string non-empty |
| patient required | object |
| started required | string non-empty |
| numberOfSeries required | number |
| numberOfInstances required | number |
| series required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| date required | string non-empty |
| vaccineCode required | object |
| patient required | object |
| wasNotGiven required | boolean |
| reported required | boolean |
| performer required | object |
| requester required | object |
| encounter required | object |
| manufacturer required | object |
| location required | object |
| lotNumber required | string non-empty |
| expirationDate required | string non-empty |
| site required | object |
| route required | object |
| doseQuantity required | object |
| note required | Array of objects non-empty |
| explanation required | object |
| reaction required | Array of objects non-empty |
| vaccinationProtocol required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| date | string <date> Vaccination (non)-Administration Date |
| dose-sequence | number Dose number within series |
| identifier | string Business identifier |
| location | string The service delivery location or facility in which the vaccine was / was to be administered |
| lot-number | string Vaccine Lot Number |
| manufacturer | string Vaccine Manufacturer |
| notgiven | string Administrations which were not given |
| patient | string The patient for the vaccination record |
| practitioner | string The practitioner who played a role in the vaccination |
| reaction-date | string <date> When reaction started |
| reaction | string Additional information on reaction |
| reason-not-given | string Explanation of reason vaccination was not administered |
| reason | string Why immunization occurred |
| status | string Immunization event status |
| vaccine-code | string Vaccine Product Administered |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| date required | string non-empty |
| vaccineCode required | object |
| patient required | object |
| wasNotGiven required | boolean |
| reported required | boolean |
| performer required | object |
| requester required | object |
| encounter required | object |
| manufacturer required | object |
| location required | object |
| lotNumber required | string non-empty |
| expirationDate required | string non-empty |
| site required | object |
| route required | object |
| doseQuantity required | object |
| note required | Array of objects non-empty |
| explanation required | object |
| reaction required | Array of objects non-empty |
| vaccinationProtocol required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| patient required | object |
| recommendation required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| date | string <date> Date recommendation created |
| dose-number | number Recommended dose number |
| dose-sequence | number Dose number within sequence |
| identifier | string Business identifier |
| information | string Patient observations supporting recommendation |
| patient | string Who this profile is for |
| status | string Vaccine administration status |
| support | string Past immunizations supporting recommendation |
| target-disease | string Disease to be immunized against |
| vaccine-type | string Vaccine recommendation applies to |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| patient required | object |
| recommendation required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| url required | string non-empty |
| version required | string non-empty |
| name required | string non-empty |
| status required | string non-empty |
| experimental required | boolean |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| date required | string non-empty |
| description required | string non-empty |
| useContext required | Array of objects non-empty |
| copyright required | string non-empty |
| fhirVersion required | string non-empty |
| dependency required | Array of objects non-empty |
| package required | Array of objects non-empty |
| global required | Array of objects non-empty |
| binary required | Array of objects |
| _binary required | Array of objects non-empty |
| page required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| date | string <date> The implementation guide publication date |
| dependency | string Where to find dependency |
| description | string The description of the implementation guide |
| experimental | string For testing purposes, not real usage |
| jurisdiction | string Intended jurisdiction for the implementation guide |
| name | string Computationally friendly name of the implementation guide |
| publisher | string Name of the publisher of the implementation guide |
| resource | string Location of the resource |
| status | string The current status of the implementation guide |
| url | string The uri that identifies the implementation guide |
| version | string The business version of the implementation guide |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| url required | string non-empty |
| version required | string non-empty |
| name required | string non-empty |
| status required | string non-empty |
| experimental required | boolean |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| date required | string non-empty |
| description required | string non-empty |
| useContext required | Array of objects non-empty |
| copyright required | string non-empty |
| fhirVersion required | string non-empty |
| dependency required | Array of objects non-empty |
| package required | Array of objects non-empty |
| global required | Array of objects non-empty |
| binary required | Array of objects |
| _binary required | Array of objects non-empty |
| page required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| moduleMetadata required | object |
| model required | Array of objects non-empty |
| valueSet required | Array of objects non-empty |
| dataRequirement required | Array of objects non-empty |
| document required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| composed-of | string What resource is being referenced |
| date | string <date> The library publication date |
| depends-on | string What resource is being referenced |
| derived-from | string What resource is being referenced |
| description | string The description of the library |
| effective | string <date> The time during which the library is intended to be in use |
| identifier | string External identifier for the library |
| jurisdiction | string Intended jurisdiction for the library |
| name | string Computationally friendly name of the library |
| predecessor | string What resource is being referenced |
| publisher | string Name of the publisher of the library |
| status | string The current status of the library |
| successor | string What resource is being referenced |
| title | string The human-friendly name of the library |
| topic | string Topics associated with the module |
| url | string The uri that identifies the library |
| version | string The business version of the library |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| moduleMetadata required | object |
| model required | Array of objects non-empty |
| valueSet required | Array of objects non-empty |
| dataRequirement required | Array of objects non-empty |
| document required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| item required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| author | string Author of the Linkage |
| item | string Matches on any item in the Linkage |
| source | string Matches on any item in the Linkage with a type of 'source' |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| item required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| mode required | string non-empty |
| subject required | object |
| encounter required | object |
| date required | string non-empty |
| source required | object |
| entry required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| code | string What the purpose of this list is |
| date | string <date> When the list was prepared |
| empty-reason | string Why list is empty |
| encounter | string Context in which list created |
| identifier | string Business identifier |
| item | string Actual entry |
| notes | string The annotation - text content |
| patient | string If all resources have the same subject |
| source | string Who and/or what defined the list contents (aka Author) |
| status | string current | retired | entered-in-error |
| subject | string If all resources have the same subject |
| title | string Descriptive name for the list |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| mode required | string non-empty |
| subject required | object |
| encounter required | object |
| date required | string non-empty |
| source required | object |
| entry required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| extension required | Array of objects non-empty |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| name required | string non-empty |
| description required | string non-empty |
| mode required | string non-empty |
| telecom required | Array of objects non-empty |
| address required | object |
| physicalType required | object |
| position required | object |
| managingOrganization required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| address-city | string A city specified in an address |
| address-country | string A country/region specified in an address |
| address-postalcode | string A postal code specified in an address |
| address-state | string A state specified in an address |
| address | string A (part of the) address of the location |
| address-use | string A use code specified in an address |
| endpoint | string Technical endpoints providing access to services operated for the location |
| identifier | string An identifier for the location |
| name | string A portion of the location's name or alias |
| near-distance | integer A distance quantity to limit the near search to locations within a specific distance Requires the near parameter to also be included |
| near | string "The coordinates expressed as [latitude]:[longitude] (using the WGS84 datum, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency) Requires the near parameter to also be included |
| operational-status | string Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping) |
| organization | string Searches for locations that are managed by the provided organization |
| partof | string A location of which this location is a part |
| status | string Searches for locations with a specific kind of status |
| type | string A code for the type of location |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| extension required | Array of objects non-empty |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| name required | string non-empty |
| description required | string non-empty |
| mode required | string non-empty |
| telecom required | Array of objects non-empty |
| address required | object |
| physicalType required | object |
| position required | object |
| managingOrganization required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| composed-of | string What resource is being referenced |
| date | string <date> The measure publication date |
| depends-on | string What resource is being referenced |
| derived-from | string What resource is being referenced |
| description | string The description of the measure |
| effective | string <date> The time during which the measure is intended to be in use |
| identifier | string External identifier for the measure |
| jurisdiction | string Intended jurisdiction for the measure |
| name | string Computationally friendly name of the measure |
| predecessor | string What resource is being referenced |
| publisher | string Name of the publisher of the measure |
| status | string The current status of the measure |
| successor | string What resource is being referenced |
| title | string The human-friendly name of the measure |
| topic | string Topics associated with the module |
| url | string The uri that identifies the measure |
| version | string The business version of the measure |
| _format | string |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| identifier | string External identifier of the measure report to be returned |
| patient | string The identity of a patient to search for individual measure report results for |
| status | string The status of the measure report |
| _format | string |
Success
| id required | string |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| type required | string non-empty |
| subtype required | object |
| subject required | object |
| operator required | object |
| deviceName required | string non-empty |
| height required | number |
| width required | number |
| frames required | number |
| _frames required | object |
| content required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| based-on | string Procedure that caused this media to be created |
| context | string Encounter / Episode associated with media |
| created | string <date> Date attachment was first created |
| date | string <date> When Media was collected |
| device | string Observing Device |
| identifier | string Identifier(s) for the image |
| operator | string The person who generated the image |
| patient | string Who/What this Media is a record of |
| site | string Body part in media |
| subject | string Who/What this Media is a record of |
| subtype | string The type of acquisition equipment/process |
| type | string photo | video | audio |
| view | string Imaging view, e.g. Lateral or Antero-posterior |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| type required | string non-empty |
| subtype required | object |
| subject required | object |
| operator required | object |
| deviceName required | string non-empty |
| height required | number |
| width required | number |
| frames required | number |
| _frames required | object |
| content required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| code required | object |
| isBrand required | boolean |
| package required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| code | string Codes that identify this medication |
| container | string E.g. box, vial, blister-pack |
| form | string powder | tablets | capsule + |
| ingredient-code | string The product contained |
| ingredient | string The product contained |
| manufacturer | string Manufacturer of the item |
| over-the-counter | string True if medication does not require a prescription |
| package-item-code | string The item in the package |
| package-item | string The item in the package |
| status | string active | inactive | entered-in-error |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| code required | object |
| isBrand required | boolean |
| package required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| status required | string non-empty |
| medicationReference required | object |
| patient required | object |
| effectiveTimePeriod required | object |
| practitioner required | object |
| prescription required | object |
| dosage required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| code | string Return administrations of this medication code |
| context | string Return administrations that share this encounter or episode of care |
| device | string Return administrations with this administration device identity |
| effective-time | string <date> Date administration happened (or did not happen) |
| identifier | string Return administrations with this external identifier |
| medication | string Return administrations of this medication resource |
| not-given | string Administrations that were not made |
| patient | string The identity of a patient to list administrations for |
| performer | string The identify of the individual who administered the medication |
| prescription | string The identity of a prescription to list administrations from |
| reason-given | string Reasons for administering the medication |
| reason-not-given | string Reasons for not administering the medication |
| status | string MedicationAdministration event status (for example one of active/paused/completed/nullified) |
| subject | string The identify of the individual or group to list administrations for |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| status required | string non-empty |
| medicationReference required | object |
| patient required | object |
| effectiveTimePeriod required | object |
| practitioner required | object |
| prescription required | object |
| dosage required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| status required | string non-empty |
| medicationReference required | object |
| patient required | object |
| dispenser required | object |
| authorizingPrescription required | Array of objects non-empty |
| type required | object |
| quantity required | object |
| daysSupply required | object |
| whenPrepared required | string non-empty |
| whenHandedOver required | string non-empty |
| dosageInstruction required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| code | string Return dispenses of this medicine code |
| context | string Returns dispenses with a specific context (episode or episode of care) |
| destination | string Return dispenses that should be sent to a specific destination |
| identifier | string Return dispenses with this external identifier |
| medication | string Return dispenses of this medicine resource |
| patient | string The identity of a patient to list dispenses for |
| performer | string Return dispenses performed by a specific individual |
| prescription | string The identity of a prescription to list dispenses from |
| receiver | string The identity of a receiver to list dispenses for |
| responsibleparty | string Return dispenses with the specified responsible party |
| status | string Return dispenses with a specified dispense status |
| subject | string The identity of a patient to list dispenses for |
| type | string Return dispenses of a specific type |
| whenhandedover | string <date> Returns dispenses handed over on this date |
| whenprepared | string <date> Returns dispenses prepared on this date |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| status required | string non-empty |
| medicationReference required | object |
| patient required | object |
| dispenser required | object |
| authorizingPrescription required | Array of objects non-empty |
| type required | object |
| quantity required | object |
| daysSupply required | object |
| whenPrepared required | string non-empty |
| whenHandedOver required | string non-empty |
| dosageInstruction required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| authoredon | string <date> Return prescriptions written on this date |
| category | string Returns prescriptions with different categories |
| code | string Return prescriptions of this medication code |
| context | string Return prescriptions with this encounter or episode of care identifier |
| date | string <date> Returns medication request to be administered on a specific date |
| identifier | string Return prescriptions with this external identifier |
| intended-dispenser | string Returns prescriptions intended to be dispensed by this Organization |
| intent | string Returns prescriptions with different intents |
| medication | string Return prescriptions of this medication reference |
| patient | string Returns prescriptions for a specific patient |
| priority | string Returns prescriptions with different priorities |
| requester | string Returns prescriptions prescribed by this prescriber |
| status | string Status of the prescription |
| subject | string The identity of a patient to list orders for |
| _format | string |
Success
| id required | string |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| status required | string non-empty |
| medicationReference required | object |
| patient required | object |
| effectiveDateTime required | string non-empty |
| informationSource required | object |
| dateAsserted required | string non-empty |
| wasNotTaken required | boolean |
| reasonForUseCodeableConcept required | object |
| note required | Array of objects non-empty |
| dosage required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| category | string Returns statements of this category of medicationstatement |
| code | string Return statements of this medication code |
| context | string Returns statements for a specific context (episode or episode of Care). |
| effective | string <date> Date when patient was taking (or not taking) the medication |
| identifier | string Return statements with this external identifier |
| medication | string Return statements of this medication reference |
| part-of | string Returns statements that are part of another event. |
| patient | string Returns statements for a specific patient. |
| source | string Who or where the information in the statement came from |
| status | string Return statements that match the given status |
| subject | string The identity of a patient, animal or group to list statements for |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| status required | string non-empty |
| medicationReference required | object |
| patient required | object |
| effectiveDateTime required | string non-empty |
| informationSource required | object |
| dateAsserted required | string non-empty |
| wasNotTaken required | boolean |
| reasonForUseCodeableConcept required | object |
| note required | Array of objects non-empty |
| dosage required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| category | string The behavior associated with the message |
| date | string <date> The message definition publication date |
| description | string The description of the message definition |
| event | string The event that triggers the message |
| focus | string A resource that is a permitted focus of the message |
| identifier | string External identifier for the message definition |
| jurisdiction | string Intended jurisdiction for the message definition |
| name | string Computationally friendly name of the message definition |
| publisher | string Name of the publisher of the message definition |
| status | string The current status of the message definition |
| title | string The human-friendly name of the message definition |
| url | string The uri that identifies the message definition |
| version | string The business version of the message definition |
| _format | string |
Success
| id required | string |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| timestamp required | string non-empty |
| event required | object |
| response required | object |
| source required | object |
| destination required | Array of objects non-empty |
| enterer required | object |
| author required | object |
| responsible required | object |
| reason required | object |
| data required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| author | string The source of the decision |
| code | string ok | transient-error | fatal-error |
| destination | string Name of system |
| destination-uri | string Actual destination address or id |
| enterer | string The source of the data entry |
| event | string Code for the event this message represents |
| focus | string The actual content of the message |
| receiver | string "Intended "real-world" recipient for the data" |
| response-id | string Id of original message |
| responsible | string Final responsibility for event |
| sender | string Real world sender of the message |
| source | string Name of system |
| source-uri | string Actual message source address or id |
| target | string Particular delivery destination within the destination |
| timestamp | string <date> Time that the message was sent |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| timestamp required | string non-empty |
| event required | object |
| response required | object |
| source required | object |
| destination required | Array of objects non-empty |
| enterer required | object |
| author required | object |
| responsible required | object |
| reason required | object |
| data required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| name required | string non-empty |
| status required | string non-empty |
| kind required | string non-empty |
| date required | string non-empty |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| responsible required | string non-empty |
| description required | string non-empty |
| uniqueId required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| contact | string Name of an individual to contact |
| date | string <date> The naming system publication date |
| description | string The description of the naming system |
| id-type | string oid | uuid | uri | other |
| jurisdiction | string Intended jurisdiction for the naming system |
| kind | string codesystem | identifier | root |
| name | string Computationally friendly name of the naming system |
| period | string <date> When is identifier valid? |
| publisher | string Name of the publisher of the naming system |
| replaced-by | string Use this instead |
| responsible | string Who maintains system namespace? |
| status | string The current status of the naming system |
| telecom | string Contact details for individual or organization |
| type | string e.g. driver, provider, patient, bank etc. |
| value | string The unique identifier |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| name required | string non-empty |
| status required | string non-empty |
| kind required | string non-empty |
| date required | string non-empty |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| responsible required | string non-empty |
| description required | string non-empty |
| uniqueId required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| _id required | object |
| text required | object |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| patient required | object |
| encounter required | object |
| dateTime required | string non-empty |
| orderer required | object |
| allergyIntolerance required | Array of objects non-empty |
| foodPreferenceModifier required | Array of objects non-empty |
| excludeFoodModifier required | Array of objects non-empty |
| oralDiet required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| additive | string Type of module component to add to the feeding |
| datetime | string <date> Return nutrition orders requested on this date |
| encounter | string Return nutrition orders with this encounter identifier |
| formula | string Type of enteral or infant formula |
| identifier | string Return nutrition orders with this external identifier |
| oraldiet | string Type of diet that can be consumed orally (i.e., take via the mouth). |
| patient | string The identity of the person who requires the diet, formula or nutritional supplement |
| provider | string The identify of the provider who placed the nutrition order |
| status | string Status of the nutrition order. |
| supplement | string Type of supplement product requested |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| _id required | object |
| text required | object |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| patient required | object |
| encounter required | object |
| dateTime required | string non-empty |
| orderer required | object |
| allergyIntolerance required | Array of objects non-empty |
| foodPreferenceModifier required | Array of objects non-empty |
| excludeFoodModifier required | Array of objects non-empty |
| oralDiet required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| status required | string non-empty |
| category required | object |
| code required | object |
| subject required | object |
| encounter required | object |
| effectiveDateTime required | string non-empty |
| valueQuantity required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| based-on | string Reference to the test or procedure request. |
| category | string The classification of the type of observation |
| code | string The code of the observation type |
| code-value-concept | string Code and coded value parameter pair |
| code-value-date | string Code and date/time value parameter pair |
| code-value-quantity | string Code and quantity value parameter pair |
| code-value-string | string Code and string value parameter pair |
| combo-code | string The code of the observation type or component type |
| combo-code-value-concept | string Code and coded value parameter pair, including in components |
| combo-code-value-quantity | string Code and quantity value parameter pair, including in components |
| combo-data-absent-reason | string The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing. |
| combo-value-concept | string The value or component value of the observation, if the value is a CodeableConcept |
| combo-value-quantity | integer The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
| component-code | string The component code of the observation type |
| component-code-value-concept | string Component code and component coded value parameter pair |
| component-code-value-quantity | string Component code and component quantity value parameter pair |
| component-data-absent-reason | string The reason why the expected value in the element Observation.component.value[x] is missing. |
| component-value-concept | string The value of the component observation, if the value is a CodeableConcept |
| component-value-quantity | integer The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
| context | string Healthcare event (Episode-of-care or Encounter) related to the observation |
| data-absent-reason | string The reason why the expected value in the element Observation.value[x] is missing. |
| date | string <date> Obtained date/time. If the obtained element is a period, a date that falls in the period |
| device | string The Device that generated the observation data. |
| encounter | string Encounter related to the observation |
| identifier | string The unique id for a particular observation |
| method | string The method used for the observation |
| patient | string The subject that the observation is about (if patient) |
| performer | string Who performed the observation |
| related | string Related Observations - search on related-type and related-target together |
| related-target | string Resource that is related to this one |
| related-type | string has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by |
| specimen | string Specimen used for this observation |
| status | string The status of the observation |
| subject | string The subject that the observation is about |
| value-concept | string The value of the observation, if the value is a CodeableConcept |
| value-date | string <date> The value of the observation, if the value is a date or period of time |
| value-quantity | integer The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
| value-string | string The value of the observation, if the value is a string, and also searches in CodeableConcept.text |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| status required | string non-empty |
| category required | object |
| code required | object |
| subject required | object |
| encounter required | object |
| effectiveDateTime required | string non-empty |
| valueQuantity required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| url required | string non-empty |
| version required | string non-empty |
| name required | string non-empty |
| status required | string non-empty |
| kind required | string non-empty |
| date required | string non-empty |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| description required | string non-empty |
| code required | string non-empty |
| comment required | string non-empty |
| base required | object |
| system required | boolean |
| type required | Array of objects |
| instance required | boolean |
| parameter required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| base | string Marks this as a profile of the base |
| code | string Name used to invoke the operation |
| date | string <date> The operation definition publication date |
| description | string The description of the operation definition |
| instance | string Invoke on an instance? |
| jurisdiction | string Intended jurisdiction for the operation definition |
| kind | string operation | query |
| name | string Computationally friendly name of the operation definition |
| param-profile | string Profile on the type |
| publisher | string Name of the publisher of the operation definition |
| status | string The current status of the operation definition |
| system | string Invoke at the system level? |
| type | string Invole at the type level? |
| url | string The uri that identifies the operation definition |
| version | string The business version of the operation definition |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| url required | string non-empty |
| version required | string non-empty |
| name required | string non-empty |
| status required | string non-empty |
| kind required | string non-empty |
| date required | string non-empty |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| description required | string non-empty |
| code required | string non-empty |
| comment required | string non-empty |
| base required | object |
| system required | boolean |
| type required | Array of objects |
| instance required | boolean |
| parameter required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| extension required | Array of objects non-empty |
| name required | string non-empty |
| telecom required | Array of objects non-empty |
| address required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| active | string A server defined search that may match any of the string fields in the Address, including line, city, state, country/region, postalCode, and/or text |
| address-city | string A city specified in an address |
| address-country | string A country/region specified in an address |
| address-postalcode | string A postal code specified in an address |
| address-state | string A state specified in an address |
| address | string A (part of the) address of the organization |
| address-use | string A use code specified in an address |
| endpoint | string Technical endpoints providing access to services operated for the organization |
| identifier | string Any identifier for the organization (not the accreditation issuer's identifier) |
| name | string A portion of the organization's name or alias |
| partof | string An organization of which this organization forms a part |
| phonetic | string A portion of the organization's name using some kind of phonetic matching algorithm |
| type | string A code for the type of organization |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| extension required | Array of objects non-empty |
| name required | string non-empty |
| telecom required | Array of objects non-empty |
| address required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| active required | boolean |
| name required | Array of objects non-empty |
| gender required | string non-empty |
| photo required | Array of objects non-empty |
| contact required | Array of objects non-empty |
| managingOrganization required | object |
| link required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| active | string Whether the patient record is active |
| address-city | string A city specified in an address |
| address-country | string A country/region specified in an address |
| address-postalcode | string A postalCode specified in an address |
| address-state | string A state specified in an address |
| address | string A server defined search that may match any of the string fields in the Address, including line, city, state, country/region, postalCode, and/or text |
| address-use | string A use code specified in an address |
| animal-breed | string The breed for animal patients |
| animal-species | string The species for animal patients |
| birthdate | string <date> The patient's date of birth |
| death-date | string <date> The date of death has been provided and satisfies this search value |
| deceased | string This patient has been marked as deceased, or as a death date entered |
string A value in an email contact | |
| family | string A portion of the family name of the patient |
| gender | string Gender of the patient |
| general-practitioner | string Patient's nominated general practitioner, not the organization that manages the record |
| given | string A portion of the given name of the patient |
| identifier | string A patient identifier |
| language | string Language code (irrespective of use value) |
| link | string All patients linked to the given patient |
| name | string A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
| organization | string The organization at which this person is a patient |
| phonetic | string A portion of either family or given name using some kind of phonetic matching algorithm |
| phone | string A value in a phone contact |
| telecom | string The value in any kind of telecom details of the patient |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| active required | boolean |
| name required | Array of objects non-empty |
| gender required | string non-empty |
| photo required | Array of objects non-empty |
| contact required | Array of objects non-empty |
| managingOrganization required | object |
| link required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| created required | string non-empty |
| organizationReference required | object |
| requestReference required | object |
| paymentStatus required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| created | string <date> Creation date fro the notice |
| identifier | string The business identifier of the notice |
| organization | string The organization who generated this resource |
| payment-status | string The type of payment notice |
| provider | string The reference to the provider |
| request | string The Claim |
| response | string The ClaimResponse |
| statusdate | string <date> The date of the payment action |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| created required | string non-empty |
| organizationReference required | object |
| requestReference required | object |
| paymentStatus required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| requestReference required | object |
| outcome required | string non-empty |
| disposition required | string non-empty |
| created required | string non-empty |
| organizationReference required | object |
| detail required | Array of objects non-empty |
| total required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| created | string <date> The creation date |
| disposition | string The contents of the disposition message |
| identifier | string The business identifier of the Explanation of Benefit |
| organization | string The organization who generated this resource |
| outcome | string The processing outcome |
| request-organization | string The organization who generated this resource |
| request-provider | string The reference to the provider who sumbitted the claim |
| request | string The reference to the claim |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| requestReference required | object |
| outcome required | string non-empty |
| disposition required | string non-empty |
| created required | string non-empty |
| organizationReference required | object |
| detail required | Array of objects non-empty |
| total required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| name required | Array of objects non-empty |
| telecom required | Array of objects non-empty |
| gender required | string non-empty |
| _gender required | object |
| birthDate required | string non-empty |
| address required | Array of objects non-empty |
| active required | boolean |
| link required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| address-city | string A city specified in an address |
| address-country | string A country/region specified in an address |
| address-postalcode | string A postal code specified in an address |
| address-state | string A state specified in an address |
| address | string A server defined search that may match any of the string fields in the Address, including line, city, state, country/region, postalCode, and/or text |
| address-use | string A use code specified in an address |
| birthdate | string <date> The person's date of birth |
string A value in an email contact | |
| gender | string The gender of the person |
| identifier | string A person Identifier |
| link | string Any link has this Patient, Person, RelatedPerson or Practitioner reference |
| name | string A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
| organization | string The organization at which this person record is being managed |
| patient | string The Person links to this Patient |
| phonetic | string A portion of name using some kind of phonetic matching algorithm |
| phone | string A value in a phone contact |
| practitioner | string The Person links to this Practitioner |
| relatedperson | string The Person links to this RelatedPerson |
| telecom | string The value in any kind of contact |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| name required | Array of objects non-empty |
| telecom required | Array of objects non-empty |
| gender required | string non-empty |
| _gender required | object |
| birthDate required | string non-empty |
| address required | Array of objects non-empty |
| active required | boolean |
| link required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| composed-of | string What resource is being referenced |
| date | string <date> The plan definition publication date |
| depends-on | string What resource is being referenced |
| derived-from | string What resource is being referenced |
| description | string The description of the plan definition |
| effective | string <date> The time during which the plan definition is intended to be in use |
| identifier | string External identifier for the plan definition |
| jurisdiction | string Intended jurisdiction for the plan definition |
| name | string Computationally friendly name of the plan definition |
| predecessor | string What resource is being referenced |
| publisher | string Name of the publisher of the plan definition |
| status | string The current status of the plan definition |
| successor | string What resource is being referenced |
| title | string The human-friendly name of the plan definition |
| topic | string Topics associated with the module |
| url | string The uri that identifies the plan definition |
| version | string The business version of the plan definition |
| _format | string |
Success
| id required | string |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| active required | boolean |
| name required | Array of objects non-empty |
| practitionerRole required | Array of objects non-empty |
| qualification required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| active | string Whether the practitioner record is active |
| address-city | string A city specified in an address |
| address-country | string A country/region specified in an address |
| address-postalcode | string A postalCode specified in an address |
| address-state | string A state specified in an address |
| address | string A server defined search that may match any of the string fields in the Address, including line, city, state, country/region, postalCode, and/or text |
| address-use | string A use code specified in an address |
| communication | string One of the languages that the practitioner can communicate with |
string A value in an email contact | |
| family | string A portion of the family name |
| gender | string Gender of the practitioner |
| given | string A portion of the given name |
| identifier | string A practitioner's Identifier |
| name | string A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
| phonetic | string A portion of either family or given name using some kind of phonetic matching algorithm |
| phone | string A value in a phone contact |
| telecom | string The value in any kind of contact |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| active required | boolean |
| name required | Array of objects non-empty |
| practitionerRole required | Array of objects non-empty |
| qualification required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| active required | boolean |
| organization required | object |
| role required | Array of objects non-empty |
| location required | Array of objects non-empty |
| healthcareService required | Array of objects non-empty |
| telecom required | Array of objects non-empty |
| period required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| active | string Whether this practitioner's record is in active use |
| date | string <date> The period during which the practitioner is authorized to perform in these role(s) |
string A value in an email contact | |
| endpoint | string Technical endpoints providing access to services operated for the practitioner with this role |
| identifier | string A practitioner's Identifier |
| location | string One of the locations at which this practitioner provides care |
| organization | string The identity of the organization the practitioner represents / acts on behalf of |
| phone | string A value in a phone contact |
| practitioner | string Practitioner that is able to provide the defined services for the organation |
| role | string The practitioner can perform this role at for the organization |
| service | string The list of healthcare services that this worker provides for this role's Organization/Location(s) |
| specialty | string The practitioner has this specialty at an organization |
| telecom | string The value in any kind of contact |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| active required | boolean |
| organization required | object |
| role required | Array of objects non-empty |
| location required | Array of objects non-empty |
| healthcareService required | Array of objects non-empty |
| telecom required | Array of objects non-empty |
| period required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| subject required | object |
| status required | string non-empty |
| code required | object |
| reasonCodeableConcept required | object |
| performer required | Array of objects non-empty |
| performedDateTime required | string non-empty |
| followUp required | Array of objects non-empty |
| notes required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| based-on | string A request for this procedure |
| category | string Classification of the procedure |
| code | string A code to identify a procedure |
| context | string Encounter or episode associated with the procedure |
| date | string <date> Date/Period the procedure was performed |
| definition | string Instantiates protocol or definition |
| encounter | string Search by encounter |
| identifier | string A unique identifier for a procedure |
| location | string Where the procedure happened |
| part-of | string Part of referenced event |
| patient | string Search by subject - a patient |
| performer | string The reference to the practitioner |
| status | string preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown |
| subject | string Search by subject |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| subject required | object |
| status required | string non-empty |
| code required | object |
| reasonCodeableConcept required | object |
| performer required | Array of objects non-empty |
| performedDateTime required | string non-empty |
| followUp required | Array of objects non-empty |
| notes required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| subject required | object |
| code required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| authored | string <date> Date request signed |
| based-on | string What request fulfills |
| body-site | string Where procedure is going to be done |
| code | string What is being requested/ordered |
| context | string Encounter or Episode during which request was created |
| definition | string Protocol or definition |
| encounter | string An encounter in which this request is made |
| identifier | string Identifiers assigned to this order |
| intent | string proposal | plan | order + |
| occurrence | string <date> When procedure should occur |
| patient | string Search by subject - a patient |
| performer | string Requested perfomer |
| performer-type | string Performer role |
| priority | string routine | urgent | asap | stat |
| replaces | string What request replaces |
| requester | string Individual making the request |
| requisition | string Composite Request ID |
| specimen | string Specimen to be tested |
| status | string draft | active | suspended | completed | entered-in-error | cancelled |
| subject | string Search by subject |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| subject required | object |
| code required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| action required | string non-empty |
| identifier required | Array of objects non-empty |
| created required | string non-empty |
| organizationReference required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| action | string The action requested by this resource |
| identifier | string The business identifier of the ProcessRequest |
| organization | string The organization who generated this request |
| provider | string The provider who regenerated this request |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| action required | string non-empty |
| identifier required | Array of objects non-empty |
| created required | string non-empty |
| organizationReference required | object |
Success
| resourceType required | string non-empty |
| fhir_comments required | Array of objects |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| requestReference required | object |
| outcome required | object |
| disposition required | string non-empty |
| created required | string non-empty |
| organizationReference required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| identifier | string The business identifier of the Explanation of Benefit |
| organization | string The organization who generated this resource |
| request-organization | string The Organization who is responsible the request transaction |
| request-provider | string The Provider who is responsible the request transaction |
| request | string The reference to the claim |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| fhir_comments required | Array of objects |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| requestReference required | object |
| outcome required | object |
| disposition required | string non-empty |
| created required | string non-empty |
| organizationReference required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| target required | Array of objects non-empty |
| period required | object |
| recorded required | string non-empty |
| reason required | Array of objects non-empty |
| location required | object |
| policy required | Array of objects |
| _policy required | Array of objects non-empty |
| agent required | Array of objects non-empty |
| entity required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| agent | string Who participated |
| agent-role | string What the agents role was |
| end | string <date> End time with inclusive boundary, if not ongoing |
| entity-id | string Identity of entity |
| entity-ref | string Identity of entity |
| location | string Where the activity occurred, if relevant |
| patient | string Target Reference(s) (usually version specific) |
| recorded | string <date> When the activity was recorded / updated |
| signature-type | string Indication of the reason the entity signed the object(s) |
| start | string <date> Starting time with inclusive boundary |
| target | string Target Reference(s) (usually version specific) |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| target required | Array of objects non-empty |
| period required | object |
| recorded required | string non-empty |
| reason required | Array of objects non-empty |
| location required | object |
| policy required | Array of objects |
| _policy required | Array of objects non-empty |
| agent required | Array of objects non-empty |
| entity required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| status required | string non-empty |
| date required | string non-empty |
| title required | string non-empty |
| subjectType required | Array of objects |
| item required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| code | string A code that corresponds to one of its items in the questionnaire |
| date | string <date> The questionnaire publication date |
| description | string The description of the questionnaire |
| effective | string <date> The time during which the questionnaire is intended to be in use |
| identifier | string External identifier for the questionnaire |
| jurisdiction | string Intended jurisdiction for the questionnaire |
| name | string Computationally friendly name of the questionnaire |
| publisher | string Name of the publisher of the questionnaire |
| status | string The current status of the questionnaire |
| title | string The human-friendly name of the questionnaire |
| url | string The uri that identifies the questionnaire |
| version | string The business version of the questionnaire |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| status required | string non-empty |
| date required | string non-empty |
| title required | string non-empty |
| subjectType required | Array of objects |
| item required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| fhir_comments required | Array of objects |
| id required | string non-empty |
| text required | object |
| contained required | Array of objects non-empty |
| status required | string non-empty |
| subject required | object |
| author required | object |
| authored required | string non-empty |
| item required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| authored | string <date> When the questionnaire response was last changed |
| author | string The author of the questionnaire response |
| based-on | string Plan/proposal/order fulfilled by this questionnaire response |
| context | string Encounter or episode associated with the questionnaire response |
| identifier | string The unique identifier for the questionnaire response |
| parent | string Procedure or observation this questionnaire response was performed as a part of |
| patient | string The patient that is the subject of the questionnaire response |
| questionnaire | string The questionnaire the answers are provided for |
| source | string The individual providing the information reflected in the questionnaire respose |
| status | string The status of the questionnaire response |
| subject | string The subject of the questionnaire response |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| fhir_comments required | Array of objects |
| id required | string non-empty |
| text required | object |
| contained required | Array of objects non-empty |
| status required | string non-empty |
| subject required | object |
| author required | object |
| authored required | string non-empty |
| item required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| category required | string non-empty |
| type required | object |
| priority required | object |
| patient required | object |
| authored required | string non-empty |
| requester required | object |
| specialty required | object |
| recipient required | Array of objects non-empty |
| reason required | object |
| description required | string non-empty |
| serviceRequested required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| authored-on | string <date> Creation or activation date |
| based-on | string Request being fulfilled |
| context | string Part of encounter or episode of care |
| definition | string Instantiates protocol or definition |
| encounter | string Originating encounter |
| group-identifier | string Part of common request |
| identifier | string Business identifier |
| intent | string Proposal, plan or order |
| occurrence-date | string <date> When the service(s) requested in the referral should occur |
| patient | string Who the referral is about |
| priority | string The priority assigned to the referral |
| recipient | string The person that the referral was sent to |
| replaces | string Request(s) replaced by this request |
| requester | string Individual making the request |
| service | string Actions requested as part of the referral |
| specialty | string The specialty that the referral is for |
| status | string The status of the referral |
| subject | string Patient referred to care or transfer |
| type | string The type of the referral |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| status required | string non-empty |
| category required | string non-empty |
| type required | object |
| priority required | object |
| patient required | object |
| authored required | string non-empty |
| requester required | object |
| specialty required | object |
| recipient required | Array of objects non-empty |
| reason required | object |
| description required | string non-empty |
| serviceRequested required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| patient required | object |
| relationship required | object |
| name required | object |
| telecom required | Array of objects non-empty |
| gender required | string non-empty |
| address required | Array of objects non-empty |
| photo required | Array of objects non-empty |
| period required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| active | string Indicates if the related person record is active |
| address-city | string A city specified in an address |
| address-country | string A country/region specified in an address |
| address-postalcode | string A postal code specified in an address |
| address-state | string A state specified in an address |
| address | string A server defined search that may match any of the string fields in the Address, including line, city, state, country/region, postalCode, and/or text |
| address-use | string A use code specified in an address |
| birthdate | string <date> The Related Person's date of birth |
string A value in an email contact | |
| gender | string Gender of the related person |
| identifier | string An Identifier of the RelatedPerson |
| name | string A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
| patient | string The patient this related person is related to |
| phonetic | string A portion of name using some kind of phonetic matching algorithm |
| phone | string A value in a phone contact |
| telecom | string The value in any kind of contact |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| patient required | object |
| relationship required | object |
| name required | object |
| telecom required | Array of objects non-empty |
| gender required | string non-empty |
| address required | Array of objects non-empty |
| photo required | Array of objects non-empty |
| period required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| authored | string <date> The date the request group was authored |
| author | string The author of the request group |
| context | string The context the request group applies to |
| definition | string The definition from which the request group is realized |
| encounter | string The encounter the request group applies to |
| group-identifier | string The group identifier for the request group |
| identifier | string External identifiers for the request group |
| intent | string The intent of the request group |
| participant | string The participant in the requests in the group |
| patient | string The identity of a patient to search for request groups |
| priority | string The priority of the request group |
| status | string The status of the request group |
| subject | string The subject that the request group is about |
| _format | string |
Success
| id required | string |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| category | string Classifications for the study |
| date | string <date> When the study began and ended |
| focus | string Drugs, devices, conditions, etc. under study |
| identifier | string Business Identifier for study |
| jurisdiction | string Geographic region(s) for study |
| keyword | string Used to search for the study |
| partof | string Part of larger study |
| principalinvestigator | string The individual responsible for the study |
| protocol | string Steps followed in executing study |
| site | string Location involved in study execution |
| sponsor | string Organization responsible for the study |
| status | string draft | in-progress | suspended | stopped | completed | entered-in-error |
| title | string Name for this study |
| _format | string |
Success
| id required | string |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| date | string <date> Start and end of participation |
| identifier | string Business Identifier for research subject |
| individual | string Who is part of study |
| patient | string Who is part of study |
| status | string candidate | enrolled | active | suspended | withdrawn | completed |
| _format | string |
Success
| id required | string |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| date required | string non-empty |
| method required | object |
| basis required | Array of objects non-empty |
| prediction required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| condition | string Condition assessed |
| date | string <date> When was assessment made? |
| encounter | string Where was assessment performed? |
| identifier | string Unique identifier for the assessment |
| method | string Evaluation mechanism |
| patient | string Who/what does assessment apply to? |
| performer | string Who did assessment? |
| probability | number Likelihood of specified outcome |
| risk | string Likelihood of specified outcome as a qualitative value |
| subject | string Who/what does assessment apply to? |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| date required | string non-empty |
| method required | object |
| basis required | Array of objects non-empty |
| prediction required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| serviceCategory required | object |
| serviceType required | Array of objects non-empty |
| specialty required | Array of objects non-empty |
| actor required | object |
| planningHorizon required | object |
| comment required | string non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| active | string Is the schedule in active use |
| actor | string The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for |
| date | string <date> Search for Schedule resources that have a period that contains this date specified |
| identifier | string A Schedule Identifier |
| type | string The type of appointments that can be booked into associated slot(s) |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| serviceCategory required | object |
| serviceType required | Array of objects non-empty |
| specialty required | Array of objects non-empty |
| actor required | object |
| planningHorizon required | object |
| comment required | string non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| url required | string non-empty |
| name required | string non-empty |
| status required | string non-empty |
| experimental required | boolean |
| date required | string non-empty |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| requirements required | string non-empty |
| _requirements required | object |
| code required | string non-empty |
| base required | string non-empty |
| type required | string non-empty |
| description required | string non-empty |
| xpath required | string non-empty |
| xpathUsage required | string non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| base | string The resource type(s) this search parameter applies to |
| code | string Code used in URL |
| component | string Defines how the part works |
| date | string <date> The search parameter publication date |
| derived-from | string Original Definition for the search parameter |
| description | string The description of the search parameter |
| jurisdiction | string Intended jurisdiction for the search parameter |
| name | string Computationally friendly name of the search parameter |
| publisher | string Name of the publisher of the search parameter |
| status | string The current status of the search parameter |
| target | string Types of resource (if a resource reference) |
| type | string number | date | string | token | reference | composite | quantity | uri |
| url | string The uri that identifies the search parameter |
| version | string The business version of the search parameter |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| url required | string non-empty |
| name required | string non-empty |
| status required | string non-empty |
| experimental required | boolean |
| date required | string non-empty |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| requirements required | string non-empty |
| _requirements required | object |
| code required | string non-empty |
| base required | string non-empty |
| type required | string non-empty |
| description required | string non-empty |
| xpath required | string non-empty |
| xpathUsage required | string non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| type required | string non-empty |
| patient required | object |
| species required | object |
| referenceSeq required | Array of objects non-empty |
| variation required | object |
| repository required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| chromosome | string Chromosome number of the reference sequence |
| coordinate | string Search parameter for region of the reference DNA sequence string. This will refer to part of a locus or part of a gene where search region will be represented in 1-based system. Since the coordinateSystem can either be 0-based or 1-based, this search query will include the result of both coordinateSystem that contains the equivalent segment of the gene or whole genome sequence. For example, a search for sequence can be represented as |
| end | number End position (0-based exclusive, which menas the acid at this position will not be included, 1-based inclusive, which means the acid at this position will be included) of the reference sequence. |
| identifier | string The unique identity for a particular sequence |
| patient | string The subject that the observation is about |
| start | number Start position (0-based inclusive, 1-based inclusive, that means the nucleic acid or amino acid at this position will be included) of the reference sequence. |
| type | string Amino Acid Sequence/ DNA Sequence / RNA Sequence |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| type required | string non-empty |
| patient required | object |
| species required | object |
| referenceSeq required | Array of objects non-empty |
| variation required | object |
| repository required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| composed-of | string What resource is being referenced |
| date | string <date> The service definition publication date |
| depends-on | string What resource is being referenced |
| derived-from | string What resource is being referenced |
| description | string The description of the service definition |
| effective | string <date> The time during which the service definition is intended to be in use |
| identifier | string External identifier for the service definition |
| jurisdiction | string Intended jurisdiction for the service definition |
| name | string Computationally friendly name of the service definition |
| predecessor | string What resource is being referenced |
| publisher | string Name of the publisher of the service definition |
| status | string The current status of the service definition |
| successor | string What resource is being referenced |
| title | string The human-friendly name of the service definition |
| topic | string Topics associated with the module |
| url | string The uri that identifies the service definition |
| version | string The business version of the service definition |
| _format | string |
Success
| id required | string |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| serviceCategory required | object |
| serviceType required | Array of objects non-empty |
| specialty required | Array of objects non-empty |
| appointmentType required | object |
| schedule required | object |
| status required | string non-empty |
| start required | string non-empty |
| end required | string non-empty |
| comment required | string non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| identifier | string A Slot Identifier |
| schedule | string The Schedule Resource that we are seeking a slot within |
| slot-type | string The type of appointments that can be booked into the slot |
| start | string <date> Appointment date/time. |
| status | string The free/busy status of the appointment |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| serviceCategory required | object |
| serviceType required | Array of objects non-empty |
| specialty required | Array of objects non-empty |
| appointmentType required | object |
| schedule required | object |
| status required | string non-empty |
| start required | string non-empty |
| end required | string non-empty |
| comment required | string non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| contained required | Array of objects non-empty |
| identifier required | Array of objects non-empty |
| accessionIdentifier required | object |
| status required | string non-empty |
| type required | object |
| subject required | object |
| receivedTime required | string non-empty |
| collection required | object |
| container required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| accession | string The accession number associated with the specimen |
| bodysite | string The code for the body site from where the specimen originated |
| collected | string <date> The date the specimen was collected |
| collector | string Who collected the specimen |
| container-id | string The unique identifier associated with the specimen container |
| container | string The kind of specimen container |
| identifier | string The unique identifier associated with the specimen |
| parent | string The parent of the specimen |
| patient | string The patient the specimen comes from |
| status | string available | unavailable | unsatisfactory | entered-in-error |
| subject | string The subject of the specimen |
| type | string The specimen type |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| contained required | Array of objects non-empty |
| identifier required | Array of objects non-empty |
| accessionIdentifier required | object |
| status required | string non-empty |
| type required | object |
| subject required | object |
| receivedTime required | string non-empty |
| collection required | object |
| container required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| url required | string non-empty |
| identifier required | Array of objects non-empty |
| version required | string non-empty |
| name required | string non-empty |
| display required | string non-empty |
| _display required | object |
| status required | string non-empty |
| experimental required | boolean |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| date required | string non-empty |
| description required | string non-empty |
| useContext required | Array of objects non-empty |
| requirements required | string non-empty |
| copyright required | string non-empty |
| _copyright required | object |
| code required | Array of objects non-empty |
| fhirVersion required | string non-empty |
| mapping required | Array of objects non-empty |
| kind required | string non-empty |
| abstract required | boolean |
| baseType required | string non-empty |
| baseDefinition required | string non-empty |
| derivation required | string non-empty |
| snapshot required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| abstract | string Whether the structure is abstract |
| base-path | string Path that identifies the base element |
| base | string Definition that this type is constrained/specialized from |
| context-type | string resource | datatype | extension |
| date | string <date> The structure definition publication date |
| derivation | string specialization | constraint - How relates to base definition |
| description | string The description of the structure definition |
| experimental | string For testing purposes, not real usage |
| ext-context | string Where the extension can be used in instances |
| identifier | string External identifier for the structure definition |
| jurisdiction | string Intended jurisdiction for the structure definition |
| keyword | string A code for the profile |
| kind | string primitive-type | complex-type | resource | logical |
| name | string Computationally friendly name of the structure definition |
| path | string A path that is constrained in the profile |
| publisher | string Name of the publisher of the structure definition |
| status | string The current status of the structure definition |
| title | string The human-friendly name of the structure definition |
| type | string Type defined or constrained by this structure |
| url | string The uri that identifies the structure definition |
| valueset | string A vocabulary binding reference |
| version | string The business version of the structure definition |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| url required | string non-empty |
| identifier required | Array of objects non-empty |
| version required | string non-empty |
| name required | string non-empty |
| display required | string non-empty |
| _display required | object |
| status required | string non-empty |
| experimental required | boolean |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| date required | string non-empty |
| description required | string non-empty |
| useContext required | Array of objects non-empty |
| requirements required | string non-empty |
| copyright required | string non-empty |
| _copyright required | object |
| code required | Array of objects non-empty |
| fhirVersion required | string non-empty |
| mapping required | Array of objects non-empty |
| kind required | string non-empty |
| abstract required | boolean |
| baseType required | string non-empty |
| baseDefinition required | string non-empty |
| derivation required | string non-empty |
| snapshot required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| url required | string non-empty |
| name required | string non-empty |
| status required | string non-empty |
| group required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| date | string <date> The structure map publication date |
| description | string The description of the structure map |
| identifier | string External identifier for the structure map |
| jurisdiction | string Intended jurisdiction for the structure map |
| name | string Computationally friendly name of the structure map |
| publisher | string Name of the publisher of the structure map |
| status | string The current status of the structure map |
| title | string The human-friendly name of the structure map |
| url | string The uri that identifies the structure map |
| version | string The business version of the structure map |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| url required | string non-empty |
| name required | string non-empty |
| status required | string non-empty |
| group required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| criteria required | string non-empty |
| contact required | Array of objects non-empty |
| reason required | string non-empty |
| status required | string non-empty |
| channel required | object |
| end required | string non-empty |
| tag required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| add-tag | string A tag to be added to the resource matching the criteria |
| contact | string Contact details for the subscription |
| criteria | string The search rules used to determine when to send a notification |
| payload | string The mime-type of the notification payload |
| status | string The current state of the subscription |
| type | string The type of channel for the sent notifications |
| url | string The uri that will receive the notifications |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| criteria required | string non-empty |
| contact required | Array of objects non-empty |
| reason required | string non-empty |
| status required | string non-empty |
| channel required | object |
| end required | string non-empty |
| tag required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| category required | Array of objects non-empty |
| code required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| category | string The category of the substance |
| code | string The code of the substance or ingredient |
| container-identifier | string Identifier of the package/container |
| expiry | string <date> Expiry date of package or container of substance |
| identifier | string Unique identifier for the substance |
| quantity | integer Amount of substance in the package |
| status | string active | inactive | entered-in-error |
| substance-reference | string A component of the substance |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| category required | Array of objects non-empty |
| code required | object |
Success
| resourceType required | string non-empty |
| fhir_comments required | Array of objects |
| id required | string non-empty |
| text required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| identifier | string External identifier |
| patient | string Patient for whom the item is supplied |
| receiver | string Who collected the Supply |
| status | string in-progress | completed | abandoned | entered-in-error |
| supplier | string Dispenser |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| fhir_comments required | Array of objects |
| id required | string non-empty |
| text required | object |
Success
| resourceType required | string non-empty |
| fhir_comments required | Array of objects |
| id required | string non-empty |
| text required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| category | string The kind of supply (central, non-stock, etc.) |
| date | string <date> When the request was made |
| identifier | string Unique identifier |
| requester | string Individual making the request |
| status | string draft | active | suspended + |
| supplier | string Who is intended to fulfill the request |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| fhir_comments required | Array of objects |
| id required | string non-empty |
| text required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| type required | object |
| status required | string non-empty |
| subject required | object |
| created required | string non-empty |
| lastModified required | string non-empty |
| creator required | object |
| owner required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| authored-on | string <date> Search by creation date |
| based-on | string Search by requests this task is based on |
| business-status | string Search by business status |
| code | string Search by task code |
| context | string Search by encounter or episode |
| focus | string Search by task focus |
| group-identifier | string Search by group identifier |
| identifier | string Search for a task instance by its business identifier |
| intent | string Search by task intent |
| modified | string <date> Search by last modification date |
| organization | string Search by responsible organization |
| owner | string Search by task owner |
| part-of | string Search by task this task is part of |
| patient | string Search by patient |
| performer | string Search by recommended type of performer (e.g., Requester, Performer, Scheduler). |
| period | string <date> Search by period Task is/was underway |
| priority | string Search by task priority |
| requester | string Search by task requester |
| status | string Search by task status |
| subject | string Search by subject |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| type required | object |
| status required | string non-empty |
| subject required | object |
| created required | string non-empty |
| lastModified required | string non-empty |
| creator required | object |
| owner required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| identifier | string An external identifier for the test report |
| issued | string <date> The test report generation date |
| participant | string The reference to a participant in the test execution |
| result | string The result disposition of the test execution |
| tester | string The name of the testing organization |
| testscript | string The test script executed to produce this report |
| _format | string |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| url required | string non-empty |
| version required | string non-empty |
| name required | string non-empty |
| status required | string non-empty |
| identifier required | object |
| experimental required | boolean |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| date required | string non-empty |
| description required | string non-empty |
| useContext required | Array of objects non-empty |
| requirements required | string non-empty |
| copyright required | string non-empty |
| metadata required | object |
| fixture required | Array of objects non-empty |
| profile required | Array of objects non-empty |
| setup required | object |
| test required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| date | string <date> The test script publication date |
| description | string The description of the test script |
| identifier | string External identifier for the test script |
| jurisdiction | string Intended jurisdiction for the test script |
| name | string Computationally friendly name of the test script |
| publisher | string Name of the publisher of the test script |
| status | string The current status of the test script |
| testscript-capability | string TestScript required and validated capability |
| title | string The human-friendly name of the test script |
| url | string The uri that identifies the test script |
| version | string The business version of the test script |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| url required | string non-empty |
| version required | string non-empty |
| name required | string non-empty |
| status required | string non-empty |
| identifier required | object |
| experimental required | boolean |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| date required | string non-empty |
| description required | string non-empty |
| useContext required | Array of objects non-empty |
| requirements required | string non-empty |
| copyright required | string non-empty |
| metadata required | object |
| fixture required | Array of objects non-empty |
| profile required | Array of objects non-empty |
| setup required | object |
| test required | Array of objects non-empty |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| meta required | object |
| text required | object |
| url required | string non-empty |
| _url required | object |
| identifier required | object |
| version required | string non-empty |
| _version required | object |
| name required | string non-empty |
| _name required | object |
| status required | string non-empty |
| experimental required | boolean |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| date required | string non-empty |
| lockedDate required | string non-empty |
| _lockedDate required | object |
| description required | string non-empty |
| copyright required | string non-empty |
| compose required | object |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| date | string <date> The value set publication date |
| description | string The description of the value set |
| expansion | string Uniquely identifies this expansion |
| identifier | string External identifier for the value set |
| jurisdiction | string Intended jurisdiction for the value set |
| name | string Computationally friendly name of the value set |
| publisher | string Name of the publisher of the value set |
| reference | string A code system included or excluded in the value set or an imported value set |
| status | string The current status of the value set |
| title | string The human-friendly name of the value set |
| url | string The uri that identifies the value set |
| version | string The business version of the value set |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| meta required | object |
| text required | object |
| url required | string non-empty |
| _url required | object |
| identifier required | object |
| version required | string non-empty |
| _version required | object |
| name required | string non-empty |
| _name required | object |
| status required | string non-empty |
| experimental required | boolean |
| publisher required | string non-empty |
| contact required | Array of objects non-empty |
| date required | string non-empty |
| lockedDate required | string non-empty |
| _lockedDate required | object |
| description required | string non-empty |
| copyright required | string non-empty |
| compose required | object |
Success
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| dateWritten required | string non-empty |
| patient required | object |
| prescriber required | object |
| dispense required | Array of objects non-empty |
Success
| _id | string Logical id of this artifact |
| _lastUpdated | string <date> When the resource version last changed |
| _profile | string Profiles this resource claims to conform to |
| _security | string Security Labels applied to this resource |
| _tag | string Tags applied to this resource |
| datewritten | string <date> Return prescriptions written on this date |
| encounter | string Return prescriptions with this encounter identifier |
| identifier | string Return prescriptions with this external identifier |
| patient | string The identity of a patient to list dispenses for |
| prescriber | string Who authorizes the vision product |
| _format | string |
Success
| id required | string |
| resourceType required | string non-empty |
| id required | string non-empty |
| text required | object |
| identifier required | Array of objects non-empty |
| dateWritten required | string non-empty |
| patient required | object |
| prescriber required | object |
| dispense required | Array of objects non-empty |
Success